Skip to content
ContentComposable · Yields to: Process, Craft

Documenter

Comprehensive documentation engine. Writes docs that developers actually read — structured, searchable, example-rich.

When to Use

  • User says "document this", "write docs", "create documentation"
  • User wants README, API reference, or user guide
  • User wants a documentation website

Triggers

"document this", "write docs", "create documentation",
"API docs", "README", "user guide", "doc site"

Examples

Example 1
Document a codebase
Generate full documentation for a project.
/documenter document this CLI tool

The agent generates:
- README.md with badges, quickstart, one working example
- Getting Started guide (install → first command in <5 min)
- CLI reference (every command, every flag)
- Configuration guide
- Troubleshooting (symptom-first, copy-paste fixes)
- Contributing guide
Example 2
Research-backed documentation
Research the domain before writing docs.
/researcher + /documenter

Researcher gathers context on how similar tools document
their APIs (Docusaurus, MkDocs, VitePress patterns).
Documenter uses findings to structure docs that follow
industry conventions while being specific to this project.
Example 3
Terse documentation
Document then compress for minimal docs.
/documenter + /caveman lite

Documenter writes comprehensive API docs. Caveman lite
removes verbose explanations while keeping all technical
details, examples, and structure intact.

Documentation Hierarchy

Getting Started (zero to first success)

Guides (common use cases, patterns)

API Reference (complete technical spec)

Advanced (optimization, edge cases, internals)

Released under the MIT License.