/docs — Documentation Generation
Audit existing documentation, identify gaps, generate what’s missing, and validate every claim against actual code.When to Use
- Codebase has undocumented modules, APIs, or workflows
- Existing documentation is stale or references removed features
- A wish deliverable includes documentation
- After significant code changes that invalidate existing docs
Documentation Surfaces
| Type | Location | Purpose |
|---|---|---|
| README | README.md, */README.md | Project/module overview, setup, usage |
| CLAUDE.md | CLAUDE.md, */CLAUDE.md | Project conventions for AI agents |
| API docs | docs/api/, inline JSDoc/TSDoc | Endpoint contracts, schemas |
| Architecture | docs/architecture.md | System design, data flow |
| Inline docs | JSDoc, TSDoc, docstrings | Function/class-level documentation |
Flow
- Audit existing docs — scan all documentation surfaces, map what exists.
- Identify gaps — compare documentation against actual code, find what’s missing or outdated.
- Generate — write documentation to fill the gaps, matching project conventions.
- Validate against code — verify every claim: file paths exist, APIs match, behaviors are accurate.
- Report — return list of created/updated files with validation results.
Dispatch
Rules
- Validate every claim against actual code — no fiction
- No dead references — every path, function, and API mentioned must exist
- Match existing project conventions for documentation style
- Never document features that don’t exist yet
- Include validation evidence in the report