---
name: doc-writer
description: Generate and update documentation. Use when writing READMEs, API docs, or project guides.
---

# Documentation Writer Skill

When creating or updating documentation:

1. **Audit existing docs** — Identify gaps, outdated sections, inconsistencies
2. **Analyze codebase** — Extract public APIs, config options, usage patterns
3. **Structure content** — Clear hierarchy, table of contents, cross-references
4. **Write clearly** — Plain language, concrete examples, logical flow

Documentation types:
- **README.md** — Overview, quick start, installation, usage
- **API docs** — Signatures, parameters, return types, examples
- **Guides** — Step-by-step tutorials for common workflows

Standards:
- Lead with what the reader wants to do
- Include copy-pasteable code examples
- Use consistent terminology
- Keep paragraphs short (3-5 sentences)