technical-documentation

technical-documentation is a skill for Claude Code, Codex from magnus919/hermes-profiles. It costs 38 tokens per session (686 once invoked), scanned A, original, MIT.

A method for writing and organizing documentation that explains how software works and how to use it. It covers API references, READMEs, command-line help, developer guides, and instructions for coding agents.

In plain words
What is it for?
Use it to write setup instructions, API endpoint references, command-line help, configuration guides, troubleshooting pages, architecture references, and documentation-site navigation.
Why use it?
Poor documentation makes tools harder to use and harder to maintain. This helps present the right details in a form that answers users' practical questions.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions AGENTS.md.

Good fit Use it to write setup instructions, API endpoint references, command-line help, configuration…

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/magnus919/hermes-profiles/technical-documentation
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add magnus919/hermes-profiles --skill technical-documentation
Clone the repo
git clone --depth 1 https://github.com/magnus919/hermes-profiles

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for technical-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/magnus919/hermes-profiles/technical-documentation.svg)](https://agentmods.dev/skills/magnus919/hermes-profiles/technical-documentation)
Your own site
<a href="https://agentmods.dev/skills/magnus919/hermes-profiles/technical-documentation"><img src="https://agentmods.dev/badge/skills/magnus919/hermes-profiles/technical-documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 38 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 686 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00038 $0.00686
Opus 5 $0.00019 $0.00343
Sonnet 5 $0.00008 $0.00137
Haiku 4.5 $0.00004 $0.00069

Measured 7d ago against content hash ac7f0b29a253, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

technical-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 7d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/technical-documentation/SKILL.md · 48 lines

How it starts

The opening of the file, as written. The whole thing — 48 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Technical Documentation Methodology

Technical documentation is the interface between a tool and its user. This methodology covers writing documentation that answers the reader's question, doesn't get in their way, and stays maintainable as the project evolves.

The Technical Writer's Domain

You own You don't own
API documentation — endpoint references, parameters, examples Editorial and long-form narrative content — that's the writer
README authorship — project overview, quickstart, configuration Brand messaging and marketing copy — that's the brand designer
CLI documentation — help text, usage patterns, exit codes Code architecture decisions — those belong to the technical architect
Agent-facing docs — AGENTS.md, skill documentation Project roadmap and product vision — that's the product manager
Reference documentation — config files, troubleshooting, architecture Performance optimization guidance — that's the debugger/SRE
Documentation site structure — IA, cross-referencing, search Code quality and standards — that's the reviewer/QA engineer

Reference Files

Reference When to load
references/readme-patterns.md Writing or restructuring a README — sections every README needs, quickstart patterns, installation variants, configuration documentation
references/api-documentation-cli-help.md Documenting APIs (endpoint structure, parameter conventions, example design, auth patterns, OpenAPI annotations) and designing CLI help text (usage line, flags, exit codes, subcommand hierarchy, man pages)
references/agent-facing-docs.md Writing AGENTS.md and skill documentation — trigger patterns, loading order, output contracts, cross-references
references/information-architecture.md Structuring a documentation site — progressive disclosure, cross-referencing, search optimization, maintenance strategy

Core Principles

Document the interface, not the implementation — Users need to know what a function does, what it expects, and what it returns. How it works internally is for the source code.

Read the full file on GitHub · 48 lines

Files

What ships with it

3 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 7d ago First seen · 48 lines · 38 tokens per session scan A ac7f0b29a253

Subscribe to this mod's changes

technical-documentation is a skill published in the GitHub repository magnus919/hermes-profiles (148 stars, last pushed 2mo ago), licensed MIT. It adds 38 tokens to every session and 686 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens