api-reference-documentation
tessl install github:secondsky/claude-skills --skill api-reference-documentationCreates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.
Review Score
68%
Validation Score
13/16
Implementation Score
38%
Activation Score
100%
Generated
Validation
Total
13/16Score
Passed| Criteria | Score |
|---|---|
metadata_version | 'metadata' field is not a dictionary |
license_field | 'license' field is missing |
body_steps | No step-by-step structure detected (no ordered list); consider adding a simple workflow |
Implementation
Suggestions 4
Score
38%Overall Assessment
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 | Score | Reasoning |
|---|---|---|
Conciseness | 2/3 | 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. |
Actionability | 2/3 | 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. |
Workflow Clarity | 1/3 | 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. |
Progressive Disclosure | 2/3 | 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. |
Activation
Score
100%Overall Assessment
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 | Score | Reasoning |
|---|---|---|
Specificity | 3/3 | Lists multiple specific concrete actions: 'Creates professional API documentation', 'using OpenAPI specifications', 'with endpoints, authentication, and interactive examples'. These are concrete, actionable capabilities. |
Completeness | 3/3 | 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). |
Trigger Term Quality | 3/3 | 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. |
Distinctiveness Conflict Risk | 3/3 | 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. |