claude-world/director-mode-lite / skills/doc-writer
doc-writer
VerifiedDocumentation templates and standards: README structure, API reference format, changelog (Keep a Changelog), and comment guidelines. Use when creating or updating documentation. Loaded automatically by the doc-writer agent.
Doc Writer Skill
Director Mode Lite - Documentation Specialist
Documentation Types
1. README.md
Essential sections:
# Project Name
Brief description (1-2 sentences)
## Quick Start
\`\`\`bash
npm install # Installation
npm start # Run
\`\`\`
## Features
- Feature 1
## Documentation
- [Getting Started](docs/getting-started.md)
- [API Reference](docs/api.md)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
MIT
2. API Documentation
For each endpoint/function:
## `functionName(param1, param2)`
Brief description.
**Parameters:**
- `param1` (string): Description
- `param2` (number, optional): Description. Default: `10`
**Returns:**
- `ResultType`: Description
**Example:**
\`\`\`javascript
const result = functionName('hello', 5);
// => { success: true }
\`\`\`
**Throws:**
- `ValidationError`: When param1 is empty
For REST endpoints, document the method and path, request headers/body, success and error responses, and a runnable curl example.
3. Code Comments
Comment complex algorithms, non-obvious business logic, workarounds (and why), and TODOs with context. Do NOT comment self-explanatory code or restate what the code already says.
// Calculate compound interest using continuous compounding formula
// This matches the bank's calculation method (see SPEC-123)
const interest = principal * Math.exp(rate * time);
4. CHANGELOG.md
Follow Keep a Changelog format:
# Changelog
## [1.2.0] - 2025-01-15
### Added
- New feature X
### Changed
- Improved performance of Y
### Fixed
- Bug in Z
### Removed
- Deprecated API endpoint
5. Architecture Docs
Cover the system overview, component relationships, data flow, and design decisions with their rationale.
Documentation Standards
Style
- Use active voice; keep sentences concise
- Define acronyms on first use; use consistent terminology
- Write for scanning: H1 for the title, H2/H3 for sections, lists, and bold key terms
Code Examples
- Make examples complete and runnable; include expected output
- Show both basic and advanced usage; handle errors
Principles
- Keep it current: update docs in the same PR as the code change
- Write for the reader: assume minimal context, lead with the common case
- Test your docs: follow your own instructions; verify every example runs
Output Format
## Documentation Update
### Files Created/Updated
- `README.md` - Added Quick Start section
### Summary
[What documentation was added/changed and why]
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 470k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 197k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |