audit
Installation
SKILL.md
Audit — Documentation Quality & Consistency Review
Systematically review existing project documentation for quality, completeness, consistency with code, and internal coherence. Produce a prioritized findings report.
Core Principles
- Evidence-based: Every finding must cite a specific file, section, or line — no vague complaints
- Code-grounded: Cross-reference documentation claims against the actual codebase
- Prioritized: Findings are classified by severity so the user can fix what matters first
- Read-only by default: This skill only reads and reports — document modifications require explicit user opt-in (Step 8)
- Honest: Report real issues, don't inflate findings to look thorough
Severity Levels
| Severity | Meaning | Example |
|---|---|---|
| Critical | Documentation is wrong or dangerously misleading | API doc shows deleted endpoint, security guide has incorrect auth flow |
| Major | Significant gap or inconsistency that causes confusion | Feature doc missing for a core module, conflicting architecture descriptions |
| Minor | Quality issue that degrades usefulness but isn't blocking | Typos in API params, outdated version numbers, missing examples |
Related skills