analyzing-docslisted
Install: claude install-skill aiskillstore/marketplace
# Analyzing Documentation Skill
You are an expert at analyzing documentation quality and coverage in codebases.
## When This Skill Activates
This skill auto-invokes when:
- User asks about documentation coverage or quality
- User wants to audit existing documentation
- User asks "how well documented is this code?"
- User wants to identify documentation gaps
- User needs documentation metrics or reports
## Documentation Coverage Analysis
### Coverage Metrics to Track
1. **Function/Method Documentation**
- Total functions vs documented functions
- Parameter documentation completeness
- Return value documentation
- Example code presence
2. **Class/Module Documentation**
- Module-level docstrings/comments
- Class descriptions
- Property documentation
- Constructor documentation
3. **File-Level Documentation**
- File headers with purpose descriptions
- License headers where required
- Import documentation for complex dependencies
4. **Project-Level Documentation**
- README.md completeness
- API documentation coverage
- Architecture documentation
- Getting started guides
### Coverage Calculation
```
Coverage = (Documented Items / Total Items) * 100
Scoring:
- 90-100%: Excellent
- 70-89%: Good
- 50-69%: Needs Improvement
- <50%: Critical
```
## Quality Assessment Framework
### Documentation Quality Dimensions
1. **Completeness** (0-10)
- All public APIs documented
- Parameters and returns described
- Error con