CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

doc-generator

Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.

Quality

75%

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 ./03-skills/doc-generator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

61%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's strength is a fully concrete output template that leaves no ambiguity about the documentation format. Its weaknesses are a stale, non-instructional metadata footer that wastes tokens and the complete absence of a workflow or coverage-validation step for going from source code to complete, accurate documentation.

Suggestions

Remove the metadata footer ("Last Updated", "Claude Code Version", "Sources", "Compatible Models") — it is time-sensitive padding that does not help Claude generate documentation and directly hurts token efficiency.

Add a brief workflow for the source-to-docs pass: identify endpoints from routes/handlers in the code, apply the template per endpoint, then validate that every public endpoint is documented and that response examples match actual schemas.

Either enrich the capability statement with the doc types listed under "Generates" (SDK examples, integration guides, error code references) or move that bullet list into a short "Scope" section so it signals what to produce rather than reading as filler.

DimensionReasoningScore

Conciseness

The template is lean, but the footer carries time-sensitive, non-instructional padding — "Last Updated: August 4, 2026", "Claude Code Version: 2.1.220", a "Compatible Models" list, and a "Sources" link — none of which helps Claude execute the task. This is more than a minor trimmable instance, matching anchor 3 ("mostly efficient but includes some unnecessary content that could be tightened") rather than anchor 4.

3 / 5

Actionability

The endpoint template is copy-paste ready — parameter table, 200/404 JSON responses, and cURL/JavaScript/Python examples — giving concrete, executable output guidance. The minor gap is that nothing addresses how to survey the source code to discover endpoints and behaviors in the first place, so it falls just short of anchor 5.

4 / 5

Workflow Clarity

No sequence is stated at all (no "identify endpoints from source, apply template, verify coverage and example accuracy") and no validation checkpoint exists for this batch-style operation, which the rubric caps at 3. It is not 2 because the output contract is well defined enough that the implicit single pass is coherent, but the simple-skill exception cannot lift it above 3 without coverage validation.

3 / 5

Progressive Disclosure

No bundle files exist (no references/, scripts/, or assets/), and the body is organized into a clean "Generates" list plus a "Documentation Structure" section with the template appropriately inline at this size. It narrowly misses anchor 5's under-50-lines well-organized exception (the body runs ~80 lines and the metadata footer sits outside any section), so anchor 4 fits.

4 / 5

Total

14

/

20

Passed

Description

78%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 with an explicit and well-structured "Use when..." trigger clause and solid natural keyword coverage. Its main weakness is that the capability statement rests on a single generic action, leaving the breadth of outputs (endpoint docs, SDK examples, integration guides) that the body actually covers out of the description.

DimensionReasoningScore

Specificity

The what-clause names the domain and one concrete action ("Generate comprehensive, accurate API documentation from source code"), with OpenAPI spec generation only appearing in the trigger; this matches anchor 3's "domain plus 1-2 concrete actions, not comprehensive" rather than anchor 4's "several specific actions". "Comprehensive, accurate" is mild padding that adds no capability.

3 / 5

Completeness

Both what ("Generate comprehensive, accurate API documentation from source code") and when ("Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation") are explicit, with concrete trigger phrases matching the anchor-5 example pattern exactly. Not score 4 because the when-clause is already fully explicit and specific.

5 / 5

Trigger Term Quality

Natural trigger terms include "API documentation", "OpenAPI specs", "API docs", "endpoints", and "documentation", giving good keyword coverage. Missing common synonyms like "Swagger", "spec", and "reference docs" keep it below anchor 5's comprehensive synonym/extension coverage.

4 / 5

Distinctiveness Conflict Risk

API documentation/OpenAPI generation is a clear niche with distinct triggers. Minor overlap risk remains because the bare trigger "endpoints" could also fire when a user wants to implement an endpoint rather than document one, keeping it just below anchor 5.

4 / 5

Total

16

/

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

luongnv89/claude-howto

Path

03-skills/doc-generator/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.