Audit documentation quality and coverage
Analyzes documentation quality, coverage, and adherence to standards with checklist or detailed reporting.
/plugin marketplace add hculap/better-code/plugin install doc-master@better-code[path] [--detailed | --checklist]Analyze existing documentation for quality, completeness, and adherence to configured standards.
path (optional): Directory to audit (default: ./docs or project root)--detailed: Generate comprehensive report with scores and recommendations--checklist: Quick pass/fail checklist (default mode)Read .claude/doc-master.local.md to determine active documentation standard:
If no configuration exists, suggest running /doc-master:setup first, but proceed with Diátaxis as default.
Search for documentation files:
- README.md, README files
- docs/ directory
- *.md files in common locations
- API documentation (openapi.yaml, swagger.json)
- Inline documentation (JSDoc, docstrings)
Quick pass/fail assessment:
Completeness
Accuracy
Clarity
Organization
Comprehensive analysis with scoring:
1. Coverage Analysis (0-10)
2. Quality Score (0-10)
3. Freshness Assessment (0-10)
4. Structure Analysis (0-10)
5. Accessibility Check
Output findings to console:
Checklist Mode:
Documentation Audit - Checklist
===============================
Path: ./docs
Completeness
[✓] README exists
[✓] Installation documented
[✗] API endpoints missing documentation
[✓] Configuration documented
Accuracy
[✓] Code examples appear current
[✗] Version info missing
[✓] Links valid
Clarity
[✓] Descriptive headings
[✓] Code examples present
[✗] Inconsistent formatting in 3 files
Organization
[✓] Logical structure
[✗] No table of contents
[✓] Related content linked
Result: 9/13 checks passed
Priority fixes:
1. Add API endpoint documentation
2. Add version information
3. Add table of contents
Detailed Mode:
Documentation Audit - Detailed Report
=====================================
Path: ./docs
Standard: Diátaxis
Date: 2024-01-25
Executive Summary
-----------------
Overall Score: 7.2/10
The documentation is functional but has gaps in API coverage
and could benefit from better organization.
Scores by Category
------------------
| Category | Score | Status |
|----------------|-------|-----------|
| Completeness | 6/10 | Needs work|
| Accuracy | 8/10 | Good |
| Clarity | 7/10 | Adequate |
| Organization | 7/10 | Adequate |
| Freshness | 8/10 | Good |
Coverage Analysis
-----------------
Documented:
- User authentication (complete)
- Configuration (complete)
- Getting started (complete)
Missing:
- Payment API endpoints
- Webhook handlers
- Error codes reference
[Additional detailed sections...]
Action Items
------------
Priority 1 (Critical):
- Document Payment API endpoints
- Add error codes reference
Priority 2 (Important):
- Add table of contents to main docs
- Update screenshots in tutorial
Priority 3 (Nice to have):
- Add more code examples
- Improve cross-references
--checklist for quick health checks--detailed before major releases