api-documentation-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

88%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

87%

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

The skill provides a clean, copy-paste-ready documentation template that is lean and well-organized. Its main gap is workflow clarity: it specifies the output format but not the process for deriving it from source code.

Suggestions

Add a short numbered workflow for deriving docs from source (e.g., 1. scan routes/handlers, 2. extract parameters and response shapes, 3. fill the template, 4. verify examples against actual responses) so the generation process is sequenced rather than only the output format.

Include a validation/checklist step to confirm generated examples match the real source signatures before finalizing the documentation.

Optionally split the per-endpoint template into a reference file and keep SKILL.md as an overview pointing to it, if the template grows beyond a single screen.

Dimension	Reasoning	Score
Conciseness	The body is a lean template with no concept explanations Claude already knows — it jumps straight into the output structure with concrete examples, and every section (parameters table, response bodies, code samples) earns its place as the deliverable format, matching the anchor 3 'lean and efficient' example.	3 / 3
Actionability	Provides a complete, copy-paste-ready markdown template with a parameters table, full JSON response bodies, and executable cURL/JavaScript/Python examples, matching anchor 3 'fully executable code/commands; copy-paste ready'.	3 / 3
Workflow Clarity	The body defines the output format per endpoint but never sequences how to get from source code to that documentation (no analyze-extract-render steps) and includes no validation/checkpoints, matching anchor 2 'sequence present but checkpoints missing' rather than the fully sequenced anchor 3.	2 / 3
Progressive Disclosure	A self-contained single file with no bundle references to chase, organized into clear sections (Generates, Documentation Structure) — for a simple single-purpose skill this matches the scoring note allowing a 3 for well-organized sections with no need for external references.	3 / 3
	Total	11 / 12 Passed

Description

90%

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, well-structured description that clearly answers both what the skill does and when to use it with natural trigger terms and a distinct niche. The only soft spot is specificity, which lists a couple of actions but not a comprehensive set.

Dimension	Reasoning	Score
Specificity	Names the domain and a couple of concrete actions ('Generate comprehensive, accurate API documentation from source code', 'generating OpenAPI specs') but stops short of a comprehensive list of multiple specific actions, matching the anchor 'Names domain and some actions, but not comprehensive' rather than the multi-action anchor 3 example.	2 / 3
Completeness	Explicitly states what it does ('Generate... API documentation from source code') and when to use it ('Use when creating or updating API documentation... or when users mention API docs, endpoints, or documentation'), satisfying the anchor 3 requirement for both what and an explicit 'Use when' trigger.	3 / 3
Trigger Term Quality	Covers natural terms users would say — 'API documentation', 'OpenAPI specs', 'API docs', 'endpoints', 'documentation' — giving good coverage of common variations, matching the anchor 3 example.	3 / 3
Distinctiveness Conflict Risk	Targets a clear niche (API documentation generation from source code) with distinct triggers (API docs, endpoints, OpenAPI specs) unlikely to fire for unrelated skills, matching anchor 3.	3 / 3
	Total	11 / 12 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: luongnv89/claude-howto
Path: 03-skills/doc-generator/SKILL.md
Commit: 97fc961

Reviewed: 4 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.