Validates PopKit documentation quality using concrete coverage metrics, accuracy checks, and freshness analysis
/plugin marketplace add jrc1883/popkit-claude/plugin install popkit@popkit-marketplaceThis 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.mdProvides 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 refreshThis skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.
This skill should be used when the user asks to "create an agent", "add an agent", "write a subagent", "agent frontmatter", "when to use description", "agent examples", "agent tools", "agent colors", "autonomous agent", or needs guidance on agent structure, system prompts, triggering conditions, or agent development best practices for Claude Code plugins.
This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.