docs

Docs

Generates and audits documentation -- TSDoc for every export, changelogs from commits, README accuracy checks, and coverage reports that show exactly what is undocumented.

Level	L1 Vibe Coder
Category	Domain Specialist
Model	Sonnet

---

What It Does

The Docs agent treats documentation as a first-class deliverable, not an afterthought. It generates TSDoc/JSDoc for TypeScript code with proper parameter descriptions, return types, and usage examples. It creates changelogs from conventional commit messages, grouping entries by Added/Fixed/Changed. It audits existing documentation for staleness and gaps -- finding README sections that describe features that no longer exist, API docs that do not match implemented endpoints, and public functions that lack docstrings.

What makes this agent more than "add a comment above each function" is its understanding of documentation quality. It writes TSDoc that explains the why, not the what. A function called calculateHealthScore does not need a docstring that says "Calculates the health score." It needs one that explains the weighted formula, the input ranges, and a usage example that shows real values. The Docs agent generates this level of documentation because it reads the implementation, understands the logic, and writes descriptions that a newcomer would find useful.

The agent also performs documentation audits. It scans all public exports and reports a coverage metric: documented / total public APIs. It flags documentation older than 30 days for review. It compares README sections against the actual project structure and reports discrepancies. This turns documentation from a "we should do this someday" task into a measurable quality dimension with a concrete number to improve.

When to Use It

• After adding new components or services: When new code has been written and needs comprehensive TSDoc documentation with parameter descriptions and examples.
• Before a release: When you need a changelog generated from conventional commits covering everything since the last version tag.
• When documentation feels stale: When you suspect the README, API docs, or architecture guides no longer match the actual codebase and need an audit.
• When onboarding a new team member: When you need documentation coverage increased across the codebase so newcomers can understand the code through its docs.