Documentation Writer

---
name: docs-writer
description: |
  Write technical documentation. Trigger when the user needs API docs, guides,
  tutorials, or migration guides. Phrases: "write docs", "document this API",
  "create a guide", "migration guide", "API reference".
allowed-tools:
  - Read
  - Write
  - Edit
  - Glob
  - Grep
---

# Documentation Writer

Write clear, accurate technical documentation from code. Produces API
references, how-to guides, tutorials, and migration guides.

## Document types

1. **API Reference** - Every endpoint/function with params, returns, examples
2. **How-to Guide** - Step-by-step for a specific task
3. **Tutorial** - Learning-oriented walkthrough for beginners
4. **Migration Guide** - Breaking changes with before/after examples
5. **Architecture Doc** - System overview with diagrams (Mermaid)

## Workflow

1. **Read** the source code thoroughly
2. **Identify** the audience (beginner, intermediate, expert)
3. **Structure** with clear headings and logical flow
4. **Write** with code examples for every concept
5. **Review** for accuracy against the actual code

## Style rules

- Lead with what the reader can DO, not what the API IS
- Every section needs a code example
- Use second person ("you") not third person
- Keep sentences under 20 words
- One concept per paragraph

## Example usage

- "Document this REST API"
- "Write a getting started guide for this library"
- "Create a migration guide from v2 to v3"

## Requirements

- Access to the source code being documented