api-reference-documentation
Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.
78
68%
Does it follow best practices?
Impact
93%
1.01xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.mdQuality
Discovery
100%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This is a well-crafted skill description that excels across all dimensions. It provides specific capabilities (OpenAPI specs, endpoints, authentication, interactive examples), uses natural developer terminology, includes an explicit 'Use when' clause with clear triggers, and carves out a distinct niche in API documentation that won't conflict with other skills.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'Creates professional API documentation', 'using OpenAPI specifications', 'endpoints, authentication, and interactive examples'. These are concrete, actionable capabilities. | 3 / 3 |
Completeness | Clearly answers both what (creates API documentation with OpenAPI specs, endpoints, auth, examples) AND when (explicit 'Use when' clause covering REST APIs, SDK references, developer portals). | 3 / 3 |
Trigger Term Quality | Includes natural keywords users would say: 'API documentation', 'OpenAPI specifications', 'REST APIs', 'SDK references', 'developer portals'. Good coverage of terms developers naturally use when needing this skill. | 3 / 3 |
Distinctiveness Conflict Risk | Clear niche focused on API documentation specifically. Terms like 'OpenAPI specifications', 'REST APIs', 'SDK references', and 'developer portals' create a distinct domain unlikely to conflict with general documentation or coding skills. | 3 / 3 |
Total | 12 / 12 Passed |
Implementation
37%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill provides a useful OpenAPI specification template but lacks actionable workflow guidance for actually creating API documentation. The checklist and best practices are generic knowledge Claude already possesses, and there's no clear process for going from spec to published documentation with validation steps.
Suggestions
Add a step-by-step workflow: 1) Write/validate OpenAPI spec, 2) Generate docs with specific tool command, 3) Verify output, 4) Deploy
Include executable commands for doc generation (e.g., `npx @redocly/cli build-docs openapi.yaml --output docs.html`)
Remove or condense the generic best practices and checklist items that Claude already knows
Add validation step with specific command (e.g., `npx @redocly/cli lint openapi.yaml`) before generating documentation
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is reasonably efficient but includes some unnecessary elements like the full OpenAPI spec example which is quite verbose. The checklist and best practices sections contain items Claude already knows about API documentation. | 2 / 3 |
Actionability | Provides a concrete OpenAPI spec example which is helpful, but the checklist and best practices are abstract guidance rather than executable instructions. Missing actual commands for generating docs or validating specs. | 2 / 3 |
Workflow Clarity | No clear workflow or sequence for creating API documentation. The content presents a spec example, a checklist, and best practices but doesn't explain how to actually produce documentation from start to finish or validate the output. | 1 / 3 |
Progressive Disclosure | Content is organized into logical sections but everything is inline in one file. The tools section could link to detailed guides for each tool. No references to external files for advanced topics like SDK generation or migration guides. | 2 / 3 |
Total | 7 / 12 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 — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
- Repository
- secondsky/claude-skills
- Commit
90d6bd7
- 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.