Agent-Skills.md

Agent Skills: docs-master

Documentation creation and summarization. Use when the user asks to "write docs", "create documentation", "update README", "document this", "summarize code", "add docs", "write a changelog", "document the API", "explain this module", or mentions documentation, summarization, or README updates.

UncategorizedID: cfircoo/claude-code-toolkit/docs-master

Repository

cfircoo/claude-code-toolkit
cfircooLicense: MIT
161

Install this agent skill to your local

pnpm dlx add-skill https://github.com/cfircoo/claude-code-toolkit/tree/HEAD/skills/docs-master

Skill Files

Browse the full folder contents for docs-master.

Download Skill

Loading file tree…

skills/docs-master/SKILL.md

Skill Metadata

Name
docs-master
Description
Documentation creation and summarization. Use when the user asks to "write docs", "create documentation", "update README", "document this", "summarize code", "add docs", "write a changelog", "document the API", "explain this module", or mentions documentation, summarization, or README updates.
<objective> Create, update, and summarize project documentation. All docs go in `docs/`. Maintains `docs/index.md` as the central navigation hub. README.md is always kept in sync. Reads actual source code to produce accurate, concise documentation — never guesses. </objective> <capabilities> | Request | What Happens | |---------|-------------| | "document feature X" | Reads source code, creates `docs/feature-x.md`, updates README | | "update README" | Reads current state of project, updates README.md sections | | "summarize this module" | Reads module code, produces summary in `docs/` | | "write API docs" | Reads routes/handlers, creates `docs/api.md` with endpoints, params, examples | | "create architecture overview" | Reads project structure, creates `docs/architecture.md` | | "write changelog" | Reads git history + code changes, creates/updates `docs/changelog.md` | | "document component X" | Reads component source, creates `docs/{type}/{name}.md` | | "explain how X works" | Reads code, produces explanation doc in `docs/` | </capabilities> <principles> 1. **Read first, write second** — always read existing docs and source code before writing 2. **`docs/` is home — NEVER use `documentation/`** — all documentation files MUST live in `docs/`. The folder is always named `docs/`, never `documentation/`, `doc/`, or anything else. 3. **`docs/index.md` is mandatory** — every run checks if `docs/index.md` exists; creates it if missing, updates it if present. Lists every doc file as a linked table of contents. 4. **README stays current** — every run updates root README.md to reflect changes 5. **Accuracy is mandatory** — only document behavior verified from code 6. **Match the style** — follow existing formatting, tone, and conventions 7. **No code changes** — only writes `.md` files, never modifies source </principles>

<success_criteria>

  • Docs are accurate and verified against source code
  • docs/index.md exists and lists every doc file in docs/
  • README.md updated with links and references to new/changed docs
  • Follows existing project documentation style
  • Code examples are correct
  • No existing documentation silently removed </success_criteria>