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.
cfircoo Docs Master by cfircoo · df32f82
npx skillmds@latest add cfircoo/docs-master File contents
---name: docs-masterdescription: 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>
cfircoo/claude-code-toolkit/tree/main/skills/docs-master commit df32f82839
Frequently asked questions
Run npx skillmds@latest add cfircoo/docs-master in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
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. It is listed under Docs & Writing on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
cfircoo (@cfircoo) published this skill. Their other Agent Skills are listed on their SkillMD profile.