Validates PopKit documentation quality using concrete coverage metrics, accuracy checks, and freshness analysis
Inherits all available tools
Additional assets for this skill
This skill inherits all available tools. When active, it can use any tool Claude has access to.
checklists/agent-documentation.jsonchecklists/auto-generated-accuracy.jsonchecklists/claude-md-requirements.jsonchecklists/skill-documentation.jsonscripts/calculate_doc_score.pyscripts/measure_coverage.pyscripts/validate_accuracy.pystandards/agent-documentation.mdstandards/claude-md-structure.mdstandards/command-documentation.mdstandards/skill-documentation.mdname: pop-assessment-documentation description: "Validates PopKit documentation quality using concrete coverage metrics, accuracy checks, and freshness analysis" triggers:
Provides concrete, reproducible documentation assessment for PopKit plugins using:
python skills/pop-assessment-documentation/scripts/measure_coverage.py packages/plugin/
python skills/pop-assessment-documentation/scripts/validate_accuracy.py packages/plugin/
python skills/pop-assessment-documentation/scripts/calculate_doc_score.py packages/plugin/
Read and apply checklists in order:
checklists/claude-md-requirements.json - CLAUDE.md sectionschecklists/skill-documentation.json - SKILL.md requirementschecklists/agent-documentation.json - AGENT.md requirementschecklists/auto-generated-accuracy.json - Count verificationCombine automated metrics with checklist results for final documentation report.
| Standard | File | Key Checks |
|---|---|---|
| CLAUDE.md Structure | standards/claude-md-structure.md | CM-001 through CM-012 |
| Skill Documentation | standards/skill-documentation.md | SKD-001 through SKD-008 |
| Agent Documentation | standards/agent-documentation.md | AGD-001 through AGD-012 |
| Command Documentation | standards/command-documentation.md | CMD-001 through CMD-008 |
| Category | Target | Warning | Critical |
|---|---|---|---|
| Skills with SKILL.md | 100% | 90-99% | <90% |
| Agents with AGENT.md | 100% | 90-99% | <90% |
| Commands documented | 100% | 90-99% | <90% |
| Examples provided | >80% | 50-80% | <50% |
| Auto-gen accuracy | 100% | 95-99% | <95% |
| Section | Check ID | Required |
|---|---|---|
| Project Overview | CM-001 | Yes |
| Repository Structure | CM-002 | Yes |
| Development Notes | CM-003 | Yes |
| Key Architectural Patterns | CM-004 | Yes |
| Key Files Table | CM-005 | Yes |
| Version History | CM-006 | No |
| Conventions | CM-007 | Yes |
Returns JSON with:
doc_score: 0-100 (higher = better)coverage: Percent of items documentedaccuracy: Percent matching realityfreshness: Days since last updategaps: Missing documentation itemsstale_docs: Documents needing refresh