Stats
Actions
Tags
From solution-audit
This skill should be used when the user asks to "audit documentation", "check doc quality", "find broken links", "review README", "check if docs are up to date", "assess documentation structure", or needs to evaluate whether documentation is accurate, useful, and well-organized beyond mere existence.
How this skill is triggered — by the user, by Claude, or both
Slash command
/solution-audit:documentation-qualityThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Assess documentation quality beyond existence checks — evaluate whether docs are useful, accurate, structured, and maintained. Bad documentation is worse than no documentation because it creates false confidence.
Assess documentation quality beyond existence checks — evaluate whether docs are useful, accurate, structured, and maintained. Bad documentation is worse than no documentation because it creates false confidence.
Documentation quality measures how well docs serve their purpose: helping users accomplish real tasks. A beautiful README that misleads is worse than a sparse one that is accurate. This audit focuses on utility, accuracy, and structure.
Inventory all documentation and classify by type:
Map each doc file to its type. Flag docs that mix types (a common quality issue — a tutorial that becomes a reference mid-way).
The README is the front door. Evaluate:
Flag README anti-patterns:
Check that documentation matches current code:
Use Grep to cross-reference documented identifiers against source code.
Verify all links in documentation:
Check that documented examples work:
Evaluate the structural organization:
Identify maintenance issues:
Assess the effectiveness of documentation prose:
| Severity | Criteria | Example |
|---|---|---|
| Critical | Docs actively mislead or block users | Install instructions that fail, wrong API signatures |
| Warning | Docs are incomplete or stale | Missing sections, outdated examples |
| Info | Minor quality or style issues | Inconsistent formatting, minor typos |
For each finding, report:
[SEVERITY] Category: Brief description
File: path/to/doc.md:line
Issue: What is wrong
Impact: How this affects users
Fix: Specific action to resolve
Start at 100, subtract per finding:
Score reflects how much users can trust and rely on the documentation.
references/doc-assessment-criteria.md — Detailed rubrics for each documentation typenpx claudepluginhub nsalvacao/nsalvacao-claude-code-plugins --plugin solution-auditProvides checklists, metrics, scoring, and grep-based detection patterns for auditing README, API, and architecture documentation quality.
Detects documentation drift, stale references, and cross-document inconsistencies in projects. Scans code-doc mismatches, broken links, outdated versions, and git staleness.
Audits documentation against source code using git-based staleness detection. Run with no args for smart check or specify a path. Supports full audit, auto-fix, and check-only modes.