| name | documentation-audit |
| description | Audit documentation quality — inline comments, API docs, README completeness, and doc-code sync. Use when assessing whether docs are good and complete. To catch docs that have gone stale versus the code use /doc-gardening instead. |
| user-invocable | true |
Documentation Audit
Core Rule
Audit doc-code sync and reader experience. Recommend rewrites only when current docs mislead — small fixes beat broad refactors.
When to Use
Invoke with /documentation-audit when:
- Assessing documentation quality for a project
- Preparing a project for open-source release
- Onboarding new team members and finding documentation gaps
- After major feature additions to ensure docs are updated
- Before a due diligence or code quality review
Default Behavior
When the user asks to audit, scan, review, or "give me a report" for documentation, produce the full documentation-audit report automatically using the Process and Output Format sections below. Do not require the user to specify fields.
Only modify files when the user explicitly requests implement / fix / apply / refactor. By default, this skill is report-only.
Process
Phase 1: Inventory (first-pass leads)
This pass produces candidates, not findings. Treat counts as leads for deeper inspection in later phases. Do not report Phase 1 raw output as the final result.
Catalog existing documentation:
- README — Does it exist? Is it useful?
- API docs — Inline docs, generated docs, API reference
