CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

71

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

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 overview with an exemplary validated workflow, concrete commands, and a clean one-level-deep reference structure backed by eight real bundle files. The main weaknesses are minor: a non-actionable keyword list under "Knowledge Reference", a placeholder JSDoc function body, and a couple of underspecified steps (coverage report format, format-preference ask).

Suggestions

Replace the 'Knowledge Reference' keyword list with actionable guidance (e.g., when to choose each docstring style or doc-site generator) or move it into a reference file — as written it lists technologies Claude already knows without adding instructions.

Complete the JSDoc example's function body instead of the '{ ... }' placeholder, so the example is fully copy-paste ready.

Make the 'Report' step concrete: specify what a coverage summary contains and point to references/coverage-reports.md for its format, mirroring how other steps cite concrete commands.

DimensionReasoningScore

Conciseness

The body is efficient — no concept explanations Claude already knows, terse workflow steps, and complete code examples. Minor trimmable padding remains: the "Knowledge Reference" section is a bare keyword list (Google/NumPy/Sphinx, FastAPI, Docusaurus, ...) that adds no actionable knowledge, and the maintainer attribution/footer lines contribute tokens without operational value. Fits the level-4 anchor (efficient with minor over-explanation to trim); it never reaches the level-3 anchor's unnecessary explanations.

4 / 5

Actionability

Concrete, copy-paste-ready validation commands ("python -m doctest file.py", "pytest --doctest-modules", "tsc --noEmit", "npx @redocly/cli lint openapi.yaml") and complete docstring examples provide strong executable guidance. Minor gaps keep it below level 5: the JSDoc example ends with a "{ ... }" placeholder body, and the "Report - Generate coverage summary" and "Discover - Ask for format preference" steps give no concrete format for the ask or the report.

4 / 5

Workflow Clarity

The six-step workflow (Discover → Detect → Analyze → Document → Validate → Report) is clearly sequenced with an explicit validation step giving per-language commands and a feedback loop ("If validation fails: fix examples and re-validate before proceeding to the Report step"). This matches the level-5 anchor: clear sequence, explicit validation steps, and an error-recovery loop; level 4 would lack the explicit re-validate instruction, which is present here.

5 / 5

Progressive Disclosure

SKILL.md is a genuine overview: a Reference Guide table signals eight one-level-deep reference files with clear "Load When" conditions, and all eight referenced files (references/python-docstrings.md, typescript-jsdoc.md, api-docs-fastapi-django.md, api-docs-nestjs-express.md, coverage-reports.md, documentation-systems.md, interactive-api-docs.md, user-guides-tutorials.md) exist in the bundle with substantive content. Content is appropriately split and navigation is easy, matching the level-5 anchor.

5 / 5

Total

18

/

20

Passed

Description

88%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 description that clearly states capabilities, artifact types, and explicit 'Use when' triggers in third person. Keyword coverage is good with natural synonyms, though a few common phrasings ("API docs", "reference documentation") are absent and the broad documentation framing carries minor overlap risk with adjacent writing skills.

DimensionReasoningScore

Specificity

"Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides" lists multiple concrete actions (generates, formats, validates) with comprehensive coverage of artifact types. This matches the anchor for multiple specific concrete actions with comprehensive coverage, exceeding the level-4 anchor only by covering the full domain without gaps.

5 / 5

Completeness

The description explicitly answers what ("Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides") and when ("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") with concrete trigger phrases. It clearly matches the level-5 anchor; level 4 would require a less explicit 'when' clause, which is not the case here.

5 / 5

Trigger Term Quality

Natural terms are well covered — "docstrings", "OpenAPI/Swagger", "JSDoc", "API documentation", "documentation sites", "tutorials and user guides", "getting started guides", "doc portals" — including synonyms (tutorials/getting started guides; doc portals/documentation sites). A few common variations are missing (e.g., "API docs", "README", "reference documentation"), which fits the anchor for good keyword coverage with a few natural terms missing rather than the comprehensive level-5 anchor.

4 / 5

Distinctiveness Conflict Risk

The documentation niche is fairly well delimited by concrete artifact types (docstrings, OpenAPI/Swagger, JSDoc, doc portals), but the broad "technical documentation" framing overlaps with general writing/README skills and code-review skills triggered by "comments". This fits "mostly distinct; minor overlap risk with closely related skills"; the level-5 anchor would require near-zero overlap with any adjacent skill.

4 / 5

Total

18

/

20

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 — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

Jeffallan/claude-skills

Path

skills/code-documenter/SKILL.md

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.