api-reference-creator
Api Reference Creator - Auto-activating skill for Technical Documentation. Triggers on: api reference creator, api reference creator Part of the Technical Documentation skill category.
34
0%
Does it follow best practices?
Impact
100%
1.00xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./planned-skills/generated/17-technical-docs/api-reference-creator/SKILL.mdQuality
Discovery
0%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 description is essentially a placeholder that repeats the skill name and category without providing any substantive information. It fails on all dimensions: no concrete actions, no natural trigger terms, no explicit 'when to use' guidance, and no distinguishing details that would help Claude select it appropriately from a pool of skills.
Suggestions
Add specific concrete actions the skill performs, e.g., 'Generates API reference documentation from code, including endpoint descriptions, request/response schemas, authentication details, and example calls.'
Add an explicit 'Use when...' clause with natural trigger terms, e.g., 'Use when the user asks to create API docs, document REST endpoints, generate OpenAPI/Swagger specs, or write reference documentation for an API.'
Include relevant file types and formats to improve distinctiveness, e.g., 'Outputs markdown or HTML API references; works with OpenAPI/Swagger YAML/JSON files, .py, .js, .ts source files.'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description provides no concrete actions. It only names itself ('Api Reference Creator') and its category ('Technical Documentation') without describing what it actually does—no mention of generating endpoints, documenting parameters, creating OpenAPI specs, etc. | 1 / 3 |
Completeness | Neither the 'what does this do' nor the 'when should Claude use it' questions are meaningfully answered. There is no 'Use when...' clause, and the description only states the skill name and category without explaining functionality or trigger conditions. | 1 / 3 |
Trigger Term Quality | The only trigger terms listed are the skill's own name repeated twice ('api reference creator'). There are no natural user keywords like 'API docs', 'endpoint documentation', 'REST API', 'swagger', 'OpenAPI', or 'API documentation'. | 1 / 3 |
Distinctiveness Conflict Risk | The description is extremely generic—'Technical Documentation' could overlap with many documentation-related skills. Without specific actions or file types, it would be nearly impossible to distinguish this from other documentation skills. | 1 / 3 |
Total | 4 / 12 Passed |
Implementation
0%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill is essentially a placeholder with no substantive content. It contains only meta-descriptions and trigger phrases but provides zero actionable guidance on how to actually create API reference documentation. There are no templates, examples, code snippets, workflows, or references to external resources.
Suggestions
Add a concrete workflow for creating API reference documentation (e.g., 1. Identify endpoints, 2. Document request/response schemas, 3. Generate examples, 4. Validate completeness).
Include at least one executable example or template showing what a well-structured API reference entry looks like (endpoint, method, parameters, response schema, example request/response).
Remove all the meta-description sections ('When to Use', 'Example Triggers', 'Capabilities') and replace them with actual instructional content—specific formats, tools, and patterns for API documentation.
Add references to supplementary files for advanced topics (e.g., OpenAPI/Swagger generation, authentication documentation patterns, versioning strategies).
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is entirely filler and meta-description. It explains what the skill does in abstract terms without providing any actual instructions, code, or concrete guidance. Every section restates the same vague information. | 1 / 3 |
Actionability | There is zero actionable content—no code, no commands, no concrete steps, no examples of API reference output, no templates. It only describes what the skill could do without showing how. | 1 / 3 |
Workflow Clarity | No workflow is defined. There are no steps, no sequence, no validation checkpoints. The bullet 'Provides step-by-step guidance' is a claim with no actual steps provided. | 1 / 3 |
Progressive Disclosure | The content is a flat, monolithic block of vague descriptions with no references to detailed files, no structured navigation, and no separation of overview from detailed content. | 1 / 3 |
Total | 4 / 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 — 9 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 9 / 11 Passed | |
- Commit
b8a3b3e
- 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.