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.
Install with Tessl CLI
npx tessl i github:secondsky/claude-skills --skill api-reference-documentationOverall
score
68%
Does it follow best practices?
If you maintain this skill, you can automatically optimize it using the tessl CLI to improve its score:
npx tessl skill review --optimize ./path/to/skillValidation for skill structure
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, 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', 'with 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 documenting REST APIs, creating SDK references, building developer portals). | 3 / 3 |
Trigger Term Quality | Includes strong natural keywords users would say: 'API documentation', 'OpenAPI specifications', 'REST APIs', 'SDK references', 'developer portals', 'endpoints', 'authentication'. Good coverage of terms developers naturally use. | 3 / 3 |
Distinctiveness Conflict Risk | Clear niche focused specifically on API documentation with distinct triggers like 'OpenAPI', 'REST APIs', 'SDK references', 'developer portals'. 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 example and reasonable checklists, but lacks actionable workflow guidance for actually creating API documentation. It reads more like a reference card than an instructional skill, missing concrete steps for generating docs with the listed tools and validation checkpoints to ensure documentation quality.
Suggestions
Add a step-by-step workflow for generating documentation (e.g., '1. Write OpenAPI spec, 2. Validate with `swagger-cli validate spec.yaml`, 3. Generate docs with Redoc')
Include executable commands for the listed tools (Swagger, Redoc, etc.) rather than just naming them
Move the full OpenAPI example to a separate reference file and keep only a minimal example inline
Add validation steps to verify the generated documentation is complete and accurate
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is reasonably efficient but includes some unnecessary elements like the full OpenAPI spec example which is 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 guidance is mostly descriptive checklists and best practices rather than executable steps. Missing actual commands for generating docs or specific workflow instructions. | 2 / 3 |
Workflow Clarity | No clear workflow or sequence for creating API documentation. The content presents a checklist and best practices but doesn't explain how to actually create documentation step-by-step 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, and the OpenAPI example could be in a separate reference file given its length. | 2 / 3 |
Total | 7 / 12 Passed |
Validation
81%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 13 / 16 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
metadata_version | 'metadata' field is not a dictionary | Warning |
license_field | 'license' field is missing | Warning |
body_steps | No step-by-step structure detected (no ordered list); consider adding a simple workflow | Warning |
Total | 13 / 16 Passed | |
- 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.