Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.
47
Quality
39%
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./docs/v19.7/configuration/agent/skills_external/antigravity-awesome-skills-main/skills/api-documenter/SKILL.mdQuality
Discovery
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 provides a reasonable foundation with explicit 'Use when' guidance and mentions specific technologies like OpenAPI 3.1. However, it relies on buzzwords like 'Master' and 'AI-powered tools' without explaining concrete capabilities, and could benefit from more natural trigger terms that users would actually say.
Suggestions
Replace vague phrases like 'Master API documentation' and 'AI-powered tools' with specific actions (e.g., 'Write OpenAPI 3.1 specifications, validate API schemas, generate client libraries')
Add common trigger term variations users would naturally say: 'swagger', 'API docs', 'REST API reference', 'API spec', '.yaml schema'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (API documentation, OpenAPI 3.1) and lists some actions (create interactive docs, generate SDKs, build developer portals), but 'Master API documentation' and 'AI-powered tools' are vague buzzwords rather than concrete actions. | 2 / 3 |
Completeness | Clearly answers both what (create interactive docs, generate SDKs, build developer portals with OpenAPI 3.1) and when ('Use PROACTIVELY for API documentation or developer portal creation'), providing explicit trigger guidance. | 3 / 3 |
Trigger Term Quality | Includes relevant terms like 'API documentation', 'OpenAPI', 'SDKs', 'developer portals', but misses common variations users might say like 'swagger', 'API docs', 'REST documentation', 'API reference', or file extensions like '.yaml', '.json'. | 2 / 3 |
Distinctiveness Conflict Risk | The focus on OpenAPI 3.1 and developer portals provides some distinction, but 'API documentation' could overlap with general documentation skills, and 'modern developer experience practices' is vague enough to conflict with other dev-focused skills. | 2 / 3 |
Total | 9 / 12 Passed |
Implementation
12%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill reads as a comprehensive capability description rather than actionable documentation guidance. It extensively lists what Claude should know about API documentation but provides no concrete examples, executable code, or specific workflows. The content is extremely verbose, explaining concepts Claude already understands while failing to provide the practical, copy-paste ready guidance that would make this skill useful.
Suggestions
Replace the extensive capability lists with 2-3 concrete, executable examples showing actual OpenAPI spec creation with working code snippets
Add specific validation commands and tools (e.g., 'npx @redocly/cli lint openapi.yaml') with expected outputs and error handling
Move detailed capability lists to separate reference files (e.g., PLATFORMS.md, AUTH-PATTERNS.md) and keep SKILL.md as a concise quick-start guide
Replace 'Example Interactions' prompts with actual input/output examples showing complete OpenAPI snippets or documentation structures
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Extremely verbose with extensive lists of capabilities, knowledge bases, and behavioral traits that Claude already knows. The content reads like a marketing document rather than actionable instructions, with significant padding that doesn't add operational value. | 1 / 3 |
Actionability | Despite listing many capabilities, there is no concrete code, no executable examples, no specific commands, and no copy-paste ready content. The 'Instructions' section is vague (4 abstract steps) and the 'Example Interactions' are just prompts, not actual examples with outputs. | 1 / 3 |
Workflow Clarity | The 'Instructions' and 'Response Approach' sections provide numbered steps, but they are abstract and lack validation checkpoints. No feedback loops for error recovery, no specific validation commands, and no concrete sequencing for complex multi-step documentation tasks. | 2 / 3 |
Progressive Disclosure | Monolithic wall of text with no references to external files. All content is inline in one massive document with no clear navigation structure. The extensive capability lists could be split into separate reference files, but instead everything is dumped into the main skill file. | 1 / 3 |
Total | 5 / 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 |
|---|---|---|
metadata_version | 'metadata.version' is missing | Warning |
Total | 10 / 11 Passed | |
20ba150
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.