code-documenter
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
96
100%
Does it follow best practices?
Impact
93%
1.10xAverage score across 6 eval scenarios
Passed
No known issues
Quality
Discovery
100%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This is a well-crafted skill description that excels across all dimensions. It provides specific concrete actions, includes comprehensive natural trigger terms that developers would actually use, explicitly states both what the skill does and when to use it, and carves out a distinct niche in technical documentation that won't conflict with general coding or writing skills.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'generates, formats, and validates' with specific outputs including 'docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides'. | 3 / 3 |
Completeness | Clearly answers both what ('Generates, formats, and validates technical documentation') AND when with explicit 'Use when...' clause covering multiple trigger scenarios like 'adding docstrings to functions', 'creating API documentation', 'building documentation sites'. | 3 / 3 |
Trigger Term Quality | Excellent coverage of natural terms users would say: 'docstrings', 'API documentation', 'OpenAPI', 'Swagger', 'JSDoc', 'doc portals', 'tutorials', 'user guides', 'getting started guides' - these are all terms developers naturally use. | 3 / 3 |
Distinctiveness Conflict Risk | Clear niche focused specifically on technical documentation with distinct triggers like 'OpenAPI/Swagger', 'JSDoc', 'docstrings' that are unlikely to conflict with general coding or writing skills. | 3 / 3 |
Total | 12 / 12 Passed |
Implementation
100%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This is a well-crafted skill that exemplifies best practices: it's concise yet comprehensive, provides executable examples across multiple languages, includes explicit validation steps with feedback loops, and uses progressive disclosure effectively through a reference table. The MUST DO/MUST NOT DO constraints provide clear boundaries without being verbose.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is lean and efficient, avoiding explanations of concepts Claude already knows. Every section serves a purpose with no padding or unnecessary context about what documentation is or why it matters. | 3 / 3 |
Actionability | Provides fully executable code examples for multiple docstring formats (Google, NumPy, JSDoc), specific validation commands (doctest, tsc, redocly lint), and concrete workflow steps. Examples are copy-paste ready. | 3 / 3 |
Workflow Clarity | Clear 6-step workflow with explicit validation checkpoint in step 5, including specific commands for different languages and a feedback loop ('If validation fails: fix examples and re-validate before proceeding'). The MUST DO/MUST NOT DO constraints add additional clarity. | 3 / 3 |
Progressive Disclosure | Excellent structure with a concise overview, quick-reference examples inline, and a well-organized reference table pointing to 8 specific topic files. References are one level deep with clear 'Load When' guidance for navigation. | 3 / 3 |
Total | 12 / 12 Passed |
Validation
100%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
- Repository
- jeffallan/claude-skills
- Commit
5b76101
- Reviewed
Table of Contents
Is this your skill?
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.