CtrlK
BlogDocsLog inGet started
Tessl Logo

code-documenter

Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.

63

Quality

74%

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

Fix and improve this skill with Tessl

tessl review fix ./skills/code-documenter/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

65%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.

The body is a well-structured, token-efficient overview with excellent progressive disclosure via a load-when reference table. Its weaknesses are thin actionability (terse workflow steps with no concrete detection cues or examples) and missing explicit validation/recovery checkpoints in the workflow.

Suggestions

Add concrete detection cues to the Detect step (e.g., check for pyproject.toml/requirements.txt vs package.json/nest-cli.json) and a minimal docstring example per format so the body is executable without loading references.

Insert explicit validation checkpoints into the workflow (e.g., 'Verify examples run before finalizing docs; on failure, fix and re-verify') rather than leaving testing only as a constraint.

Trim the persona paragraph and the 'Knowledge Reference' name-dump, which duplicates the reference table, to tighten token efficiency.

DimensionReasoningScore

Conciseness

The body is efficient: short sections, terse workflow steps, a compact reference table, and constraint lists — it never explains concepts Claude already knows. Minor trimmable padding remains ("You are a senior technical writer with 8+ years of experience" persona prose and the 'Knowledge Reference' tech-name dump that largely duplicates the reference table), placing it at anchor 4 (efficient, minor instances that could be trimmed) rather than anchor 5 (every token earns its place).

4 / 5

Actionability

The reference table's 'Load When' column and the MUST/MUST-NOT lists give some concrete direction, but the core workflow steps are terse labels without execution detail ("Detect - Identify language and framework" gives no detection cues like checking pyproject.toml/package.json, and there are no docstring examples or commands in the body). This matches anchor 3 (some concrete guidance but incomplete, missing key details); anchor 2 would lack the concrete load-when navigation and constraints, and anchor 4 would require mostly executable guidance with only minor gaps.

3 / 5

Workflow Clarity

A clear five-step sequence exists (Discover, Detect, Analyze, Document, Report) with each step glossed in one line, but validation checkpoints are absent or only implicit — 'Test code examples in documentation' and 'Generate coverage report' are listed as constraints, not as explicit checkpoints with error-recovery loops in the workflow itself. This fits anchor 3 (steps listed but checkpoints missing or implicit); it is not anchor 4 because the workflow never tells the agent how to verify or recover, e.g., what to do when format preference conflicts with detected framework.

3 / 5

Progressive Disclosure

The SKILL.md is a lean overview with a well-signaled reference table mapping eight topics to real files (all eight paths in `references/` exist on disk), each with an explicit 'Load When' condition, and the references are one level deep (their internal .md links are example doc content, not nested skill references). This matches anchor 5 (clear overview, well-signaled one-level-deep references, content appropriately split, easy navigation).

5 / 5

Total

15

/

20

Passed

Description

83%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.

The description is strong: concrete actions, an explicit 'Use when/Invoke for' trigger clause, and distinctive technical keywords. Its only weakness is incomplete coverage of natural-term variations and slight overlap with general writing-skill territory.

Suggestions

Add missing natural trigger terms users commonly say, such as 'comments', 'README', 'docs', and popular generator names (Docusaurus, MkDocs, VitePress).

Include the coverage-report capability in the description (e.g., 'generating documentation coverage reports') to round out the action list.

Sharpen distinctiveness by scoping tutorials/user guides to 'developer guides' to avoid overlap with general writing skills.

DimensionReasoningScore

Specificity

"adding docstrings, creating API documentation, or building documentation sites" names three concrete actions with format-specific detail ("OpenAPI/Swagger specs, JSDoc, doc portals"), but coverage has minor gaps (e.g., coverage reports, framework-specific API docs appear only in the body, not the description). Fits anchor 4 (several specific actions, minor gaps) better than anchor 5, which demands comprehensive multi-action coverage like "Extract text and tables from PDF files, fill forms, merge documents, convert pages to images".

4 / 5

Completeness

Explicitly answers 'what' ("adding docstrings, creating API documentation, or building documentation sites") and 'when' with concrete trigger phrases ("Use when...", "Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides"), matching the anchor-5 pattern of a full what-plus-when description with concrete triggers. A 4 would require the 'when' clause to be weaker or less specific than the two distinct, detailed trigger lists given here.

5 / 5

Trigger Term Quality

Strong natural keywords users would say: "docstrings", "API documentation", "OpenAPI/Swagger", "JSDoc", "tutorials", "user guides". A few common variations are missing ("comments", "docs", "README", generator names like Docusaurus/MkDocs), so it fits anchor 4 (good coverage, a few natural terms missing) rather than anchor 5 (comprehensive including synonyms and extensions).

4 / 5

Distinctiveness Conflict Risk

Has a clear niche (code documentation) with distinctive technical triggers (OpenAPI, Swagger, JSDoc, docstrings), but "tutorials, user guides" and "documentation sites" overlap with general writing/markdown and doc-tooling skills, so minor overlap risk keeps it at anchor 4 rather than anchor 5 (minimal conflict risk).

4 / 5

Total

17

/

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
zebbern/claude-code-guide
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.