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.

Quality

90%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Failed to scan

The risk profile of this skill

Quality

Content

85%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured skill body with a clear validated workflow and excellent progressive disclosure via a one-level reference table. It could be tightened slightly (the keyword dump and redundant Output Formats section) and made more directly copy-pasteable, but it is actionable and navigable.

Suggestions

Trim the 'Knowledge Reference' keyword line and the 'Output Formats' section, whose content is already implied by the Reference Guide table, to improve conciseness.

Consider adding one fully-runnable end-to-end example (e.g., a complete documented function plus its doctest run) so inline guidance is copy-paste ready rather than template-only.

Optionally surface file-extension triggers (e.g., .py, .ts, openapi.yaml) in the description or reference table to strengthen trigger-term coverage.

Dimension	Reasoning	Score
Conciseness	Mostly lean with no concept-padding, but the "Knowledge Reference" keyword dump and the "Output Formats" section (which restates what the reference table already conveys) are minor instances that could be trimmed.	4 / 5
Actionability	Provides concrete executable validation commands and complete docstring/JSDoc templates, but inline examples are illustrative templates rather than full copy-paste-ready programs and most sub-task detail is deferred to reference files.	4 / 5
Workflow Clarity	The six-step Discover→Report workflow includes an explicit validation step with language-specific commands and a feedback loop ("If validation fails: fix examples and re-validate before proceeding"), matching the anchor for clear sequencing with error-recovery loops.	5 / 5
Progressive Disclosure	The body is a clear overview with a well-signaled, one-level-deep reference table (Topic \| Reference \| Load When); all eight referenced paths exist and no nested references are present.	5 / 5
	Total	18 / 20 Passed

Description

96%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong, specific description that clearly states capabilities and provides explicit, natural trigger phrases covering the documentation domain. The only weakness is its wide scope, which slightly raises overlap risk with related specialist skills.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete actions ("Generates, formats, and validates") across a comprehensive set of artifacts (docstrings, OpenAPI/Swagger specs, JSDoc, doc portals, user guides), matching the comprehensive-coverage anchor.	5 / 5
Completeness	Explicitly answers both what ("Generates, formats, and validates technical documentation — including...") and when ("Use when adding docstrings...", "Invoke for...") with concrete trigger phrases.	5 / 5
Trigger Term Quality	Comprehensive natural-term coverage including synonyms (OpenAPI/Swagger, docstrings/JSDoc) and varied user phrasings ("adding docstrings to functions or classes", "building documentation sites", "getting started guides"); only file-extension triggers are absent.	5 / 5
Distinctiveness Conflict Risk	Clear documentation niche with distinct triggers, but its breadth (docstrings + API specs + doc portals + tutorials) creates minor overlap risk with sibling doc-site or API skills rather than minimal conflict risk.	4 / 5
	Total	19 / 20 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: Jeffallan/claude-skills
Path: skills/code-documenter/SKILL.md
Commit: 882ef55

Reviewed: 3 days ago

Table of Contents

Discovery Implementation Validation

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.