Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices
Install with Tessl CLI
npx tessl i github:sickn33/antigravity-awesome-skills --skill api-documentation-generator65
Quality
47%
Does it follow best practices?
Impact
99%
1.11xAverage score across 3 eval scenarios
Optimize this skill with Tessl
npx tessl skill review --optimize ./skills/api-documentation-generator/SKILL.mdDiscovery
67%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 effectively communicates specific capabilities for API documentation generation with concrete deliverables (endpoints, parameters, examples, best practices). However, it lacks explicit trigger guidance ('Use when...') and could benefit from additional natural keywords users might employ when requesting this functionality.
Suggestions
Add a 'Use when...' clause with trigger scenarios like 'Use when the user asks to document an API, generate API docs, create endpoint documentation, or mentions swagger/OpenAPI'
Include common keyword variations users might say: 'docs', 'swagger', 'OpenAPI', 'REST API', 'API reference', 'endpoint documentation'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices' - covers documentation generation with specific deliverables. | 3 / 3 |
Completeness | Clearly answers 'what' (generate API documentation with specific components) but lacks an explicit 'Use when...' clause or trigger guidance for when Claude should select this skill. | 2 / 3 |
Trigger Term Quality | Contains relevant keywords like 'API documentation', 'endpoints', 'parameters', but missing common variations users might say like 'docs', 'swagger', 'OpenAPI', 'REST API', or file extensions. | 2 / 3 |
Distinctiveness Conflict Risk | Clear niche focused specifically on API documentation generation from code - distinct from general documentation skills or code generation skills, with specific domain markers like 'endpoints' and 'parameters'. | 3 / 3 |
Total | 10 / 12 Passed |
Implementation
27%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill is excessively verbose, explaining concepts Claude already understands (API basics, HTTP methods, authentication patterns) while providing limited actionable guidance on how to actually generate documentation from code. The examples show desired output formats but don't provide executable tooling or clear validation steps. The content would benefit significantly from being condensed to core instructions with detailed examples moved to separate reference files.
Suggestions
Reduce content by 70%+ by removing explanations of basic API concepts and focusing only on the specific documentation generation workflow and output format requirements
Add concrete, executable guidance: specify tools to use (e.g., specific OpenAPI generators, documentation extraction scripts) rather than describing the process abstractly
Split detailed examples (REST endpoint docs, GraphQL docs, auth docs) into separate reference files like EXAMPLES.md, keeping only one brief example inline
Add explicit validation steps: 'Test each code example by running it', 'Verify endpoint URLs resolve', 'Check response schemas match actual API responses'
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Extremely verbose with extensive explanations of concepts Claude already knows (what REST APIs are, what authentication is, basic HTTP methods). The document is over 400 lines when the core actionable content could be conveyed in under 100 lines. | 1 / 3 |
Actionability | Provides concrete examples of documentation output formats (REST, GraphQL, auth docs), but these are examples of what to generate rather than executable code Claude would run. The 'How It Works' section describes a process abstractly rather than providing specific commands or tools to use. | 2 / 3 |
Workflow Clarity | Steps 1-5 outline a sequence but lack validation checkpoints. There's no feedback loop for verifying generated documentation is accurate, no mention of testing examples work, and no explicit verification steps before finalizing documentation. | 2 / 3 |
Progressive Disclosure | Monolithic wall of text with everything inline. The 'Related Skills' and 'Additional Resources' sections reference external content, but the main body contains extensive examples, best practices, common pitfalls, and tools that should be split into separate reference files. | 1 / 3 |
Total | 6 / 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.
Validation — 10 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 10 / 11 Passed | |
Table of Contents
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.