CtrlK
BlogDocsLog inGet started
Tessl Logo

api-documentation-generator

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

36

Quality

33%

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 ./.agent/skills/api-documentation-generator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

7%

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

This skill is essentially an empty table of contents with no actionable content in the main file. It over-delegates to 20 sub-skill files (none of which are provided in the bundle), contains verbose filler sections explaining when to use the skill, and provides zero concrete guidance, code examples, or workflow instructions. The structure suggests deeply nested content fragmentation rather than effective progressive disclosure.

Suggestions

Add concrete, executable content to the main SKILL.md—at minimum a quick-start workflow showing how to analyze code and produce a documentation template, with actual code or command examples.

Consolidate the 20 sub-skill files into 3-5 well-organized reference documents (e.g., one for endpoint documentation templates, one for examples, one for troubleshooting) and include the most critical guidance inline.

Remove the 'When to Use This Skill' section entirely—it adds no value for Claude.

Add validation steps to the workflow, such as verifying generated docs against the actual API endpoints or validating OpenAPI spec output.

DimensionReasoningScore

Conciseness

The 'When to Use This Skill' section is entirely unnecessary padding—Claude doesn't need to be told when to generate API docs. The overview explains what API documentation is, which Claude already knows. The bulk of the file is a long list of 20 sub-skill links with no substantive content in the main file itself.

1 / 3

Actionability

The main skill file contains zero concrete guidance, no code examples, no commands, no templates, and no executable instructions. It is entirely a table of contents pointing to 20 sub-skill files, none of which are provided. There is nothing actionable in the content itself.

1 / 3

Workflow Clarity

While steps 1-5 suggest a sequence, there are no validation checkpoints, no feedback loops, and no actual workflow instructions—just links. The remaining 15 items are a flat, unstructured mix of examples, best practices, and troubleshooting with no clear sequencing or relationship to the workflow.

1 / 3

Progressive Disclosure

The skill attempts progressive disclosure by linking to sub-skills, but the references are excessive (20 files) and poorly organized—mixing workflow steps, examples, best practices, sub-topics of sub-topics (e.g., 'Getting a Token' is a sub-section of 'Authentication Documentation'), and troubleshooting into a flat numbered list. No bundle files are provided to verify the references exist, and the nesting appears to go 2+ levels deep (authentication → getting a token, using the token, token expiration).

2 / 3

Total

5

/

12

Passed

Description

60%

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 does a good job listing specific capabilities (endpoints, parameters, examples, best practices) and clearly identifies its domain (API documentation from code). However, it lacks an explicit 'Use when...' clause, which is critical for Claude to know when to select this skill, and it could benefit from more natural trigger terms and variations that users would actually say.

Suggestions

Add an explicit 'Use when...' clause, e.g., 'Use when the user asks to document an API, generate API docs, create endpoint references, or needs Swagger/OpenAPI documentation from source code.'

Include common trigger term variations such as 'API docs', 'REST API', 'OpenAPI', 'Swagger', 'endpoint documentation', 'docstrings', and 'API reference'.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions: generating API documentation from code, covering endpoints, parameters, examples, and best practices. These are concrete, identifiable deliverables.

3 / 3

Completeness

Clearly answers 'what does this do' (generate API documentation from code with specific elements), but lacks an explicit 'Use when...' clause or equivalent trigger guidance, which caps this at 2 per the rubric.

2 / 3

Trigger Term Quality

Includes good terms like 'API documentation', 'endpoints', 'parameters', and 'examples', but misses common user variations like 'API docs', 'REST API', 'Swagger', 'OpenAPI', 'docstrings', or file extensions. Coverage is decent but not comprehensive.

2 / 3

Distinctiveness Conflict Risk

The focus on API documentation from code is fairly specific, but could overlap with general documentation skills, code commenting skills, or README generation skills. The phrase 'from code' helps narrow it, but without explicit trigger boundaries it could still conflict.

2 / 3

Total

9

/

12

Passed

Validation

90%

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

Validation10 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

10

/

11

Passed

Repository
Dokhacgiakhoa/antigravity-ide
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.