docs-audit
Documentation Audit
Review doc coverage, terminology drift, and canonical doc accuracy.
Scope
- canonical doc updates for behavior, contract, or config changes
- glossary drift when new terms are introduced
- duplicated concepts across docs
- outdated names or contracts after refactors
- docs staying conceptual rather than describing implementation line-by-line
Style conventions
- One H1 per doc (page title). Headings follow semantic order.
- H1 title case, H2+ sentence case.
- Bullets starting with a word or phrase use a capital letter.
- No unnecessary fenced code blocks for content that reads as prose.
Output
For each finding: severity, affected file, what drifted or is missing, fix direction.
Then: Canonical updates needed | Optional cleanup.
Anti-patterns
- Generic prose polishing
- Duplicate explanations across docs
- Implementation detail where a concept is enough
- Treating roadmap notes as shipped behavior
More from cniska/skills
tdd
Drive implementation with red-green-refactor. Use when building features or fixing bugs test-first.
12review
Run all review skills against the current branch diff. Use when reviewing a feature branch before merge.
10plan
Design a feature or behavior change through dialogue. Use when asked to plan, scope, design, or break down work before coding.
10explore
Explore a task or design through systematic questions until reaching shared understanding. Use before implementing complex or ambiguous work.
10issue
Create a GitHub issue from a short description. Use when filing a bug, feature request, or task.
10pr
Create a pull request with review and verify. Use when the branch is ready to merge.
10