documentation — Claude Code skill: READMEs, API docs, runbooks
A skill for technical writing that drafts READMEs, API references, runbooks, architecture docs and onboarding guides. Useful when the code exists but the description does not.
npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-codeWhat documentation does
Each document type gets its own outline. A README covers what the project is, a quick start, configuration and usage. API docs list endpoints with request and response examples, auth, error codes and rate limits. A runbook holds prerequisites, the step-by-step procedure, rollback and an escalation path. Architecture docs start from context and goals, then the design and the trade-offs behind it.
Five principles run through all of it: write for the reader, put the useful part first, show instead of telling, keep it current, and link rather than duplicate. The skill fires on phrases like "document this" or "create a README", so there is no command to invoke.
What it will not do is read your codebase for you. If the docs have drifted from what the service actually does, the skill has no way to catch that, so keep the endpoints and project layout at hand before you ask for a draft.
What it helps with
- write a README with a quick start
- document API endpoints with request examples
- build a runbook with rollback steps
- record architecture decisions and trade-offs
- create an onboarding guide for a new developer
Example prompts for the agent
- document this auth module
- create a README for this repo
- write a runbook for the deploy process
How to install documentation
1Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-code2Manually: put the files in place
~/.claude/skills/documentation/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/documentation/
1Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a codex2Manually: put the files in place
.agents/skills/documentation/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a cursor2Manually: put the files in place
.cursor/skills/documentation/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install anthropics/knowledge-work-plugins documentation2Manually: put the files in place
.github/skills/documentation/SKILL.md1Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a gemini-cli2Platform CLI
gemini skills install https://github.com/anthropics/knowledge-work-plugins --path engineering/skills/documentationManually: put the files in place
.devin/skills/documentation/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add anthropics/knowledge-work-plugins --skill documentation -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
From the same set89
The whole set →Similar
Questions about documentation
How do I install documentation in Claude?
Run npx skills add anthropics/knowledge-work-plugins --skill documentation -a claude-code. The skill file then lands at ~/.claude/skills/documentation/SKILL.md.
What does the documentation skill do?
It helps write and maintain technical documentation: READMEs, API references, runbooks, architecture docs and onboarding guides.
Which platforms support documentation?
Besides Claude, it installs into Codex, Cursor, GitHub Copilot, Gemini CLI and OpenCode. GitHub Copilot uses a different command: gh skill install anthropics/knowledge-work-plugins documentation.
Source text
SKILL.md · Apache-2.0
--- name: documentation description: Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks. --- # Technical Documentation Write clear, maintainable technical documentation for different audiences and purposes. ## Document Types ### README - What this is and why it exists - Quick start (< 5 minutes to first success) - Configuration and usage - Contributing guide ### API Documentation - Endpoint reference with request/response examples - Authentication and error codes - Rate limits and pagination - SDK examples ### Runbook - When to use this runbook - Prerequisites and access needed - Step-by-step procedure - Rollback steps - Escalation path ### Architecture Doc - Context and goals - High-level design with diagrams - Key decisions and trade-offs - Data flow and integration points ### Onboarding Guide - Environment setup - Key systems and how they connect - Common tasks with walkthroughs - Who to ask for what ## Principles 1. **Write for the reader** — Who is reading this and what do they need? 2. **Start with the most useful information** — Don't bury the lede 3. **Show, don't tell** — Code examples, commands, screenshots 4. **Keep it current** — Outdated docs are worse than no docs 5. **Link, don't duplicate** — Reference other docs instead of copying
© anthropics · Apache-2.0 · anthropics/knowledge-work-plugins