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.
94
92%
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
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 strong skill description that clearly defines its scope around technical documentation, lists concrete actions and artifact types, and provides explicit trigger guidance via both 'Use when' and 'Invoke for' clauses. The description covers a wide range of natural trigger terms that users would employ when needing documentation help, making it highly effective for skill selection.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'generates, formats, and validates technical documentation' with explicit subtypes including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. | 3 / 3 |
Completeness | Clearly answers both 'what' (generates, formats, validates technical documentation of various types) and 'when' (explicit 'Use when...' clause covering adding docstrings, creating API docs, building doc sites, writing tutorials, plus an additional 'Invoke for...' clause with more triggers). | 3 / 3 |
Trigger Term Quality | Excellent coverage of natural terms users would say: 'docstrings', 'OpenAPI', 'Swagger', 'JSDoc', 'API documentation', 'documentation sites', 'tutorials', 'user guides', 'getting started guides', 'doc portals'. These are terms users would naturally use when requesting documentation help. | 3 / 3 |
Distinctiveness Conflict Risk | Clearly carved out niche around technical documentation with highly specific triggers like OpenAPI/Swagger, JSDoc, doc portals, and docstrings. Unlikely to conflict with general coding skills or other writing skills due to the specificity of the documentation domain. | 3 / 3 |
Total | 12 / 12 Passed |
Implementation
85%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-structured skill with strong actionability and excellent progressive disclosure through its reference table. The workflow is clear with proper validation checkpoints and feedback loops. Minor weaknesses include some unnecessary verbosity in the constraints section and the Knowledge Reference list, which adds tokens without adding value Claude wouldn't already have.
Suggestions
Remove or significantly trim the 'Knowledge Reference' line at the bottom — Claude already knows these technologies and listing them wastes tokens.
Consider moving the three full docstring examples into a reference file and keeping only one brief example inline, since detailed format guidance is already deferred to reference files.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Generally efficient but includes some unnecessary content like the 'Knowledge Reference' list at the bottom (Claude already knows these technologies) and the constraints section has some obvious items ('Write inaccurate or untested documentation'). The examples are useful but three full docstring examples is borderline verbose when the reference files could hold them. | 2 / 3 |
Actionability | Provides fully executable, copy-paste-ready docstring examples in multiple formats (Google, NumPy, JSDoc), specific validation commands for each language/tool, and concrete workflow steps. The examples are realistic and complete. | 3 / 3 |
Workflow Clarity | The 6-step core workflow is clearly sequenced with an explicit validation step that includes specific commands per language, a feedback loop ('If validation fails: fix examples and re-validate before proceeding'), and a clear gate before the final Report step. | 3 / 3 |
Progressive Disclosure | Excellent use of a reference table with 8 clearly labeled sub-topics, each with a specific file path and a 'Load When' column explaining when to consult them. The main SKILL.md stays at overview level with quick-reference examples while deferring detailed guidance to one-level-deep reference files. | 3 / 3 |
Total | 11 / 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
5e8b6b8
- 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.