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 is an extremely weak description that essentially only restates the skill's 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 characteristics. It reads like auto-generated boilerplate rather than a useful skill description.
Suggestions
Add specific concrete actions the skill performs, e.g., 'Generates API reference documentation including endpoint descriptions, request/response schemas, authentication details, and code examples from source code or OpenAPI specs.'
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 documentation, or write reference guides for APIs.'
Remove the redundant duplicate trigger term and replace with varied natural keywords users would actually say, such as 'API documentation', 'REST docs', 'endpoint reference', 'swagger docs', '.yaml spec'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description contains no concrete actions whatsoever. 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 provides no information about capabilities beyond the skill name itself. | 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 other terms a user would naturally use. | 1 / 3 |
Distinctiveness Conflict Risk | The description is so generic ('Technical Documentation') that it could easily conflict with any other documentation-related skill. There are no distinct triggers or specific scope boundaries to differentiate it. | 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 an empty shell with no substantive content. It consists entirely of generic boilerplate that restates the skill name in various ways without providing any actual guidance, examples, templates, or actionable instructions for creating API references. It fails on every dimension of the rubric.
Suggestions
Add concrete, executable examples showing how to generate API reference documentation (e.g., a template for endpoint documentation with method, path, parameters, request/response examples).
Include a clear workflow with steps such as: 1) Extract API endpoints, 2) Document each endpoint using a provided template, 3) Validate completeness against a checklist, 4) Generate output in the target format.
Provide at least one complete input/output example—e.g., given a code snippet or OpenAPI spec, show the expected API reference output.
Remove all generic boilerplate sections ('When to Use', 'Example Triggers', 'Capabilities') that contain no actionable information and replace them with actual domain-specific guidance.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is entirely filler and boilerplate. It explains nothing Claude doesn't already know, contains no domain-specific information, and every section restates the same vague concept ('api reference creator') without adding value. | 1 / 3 |
Actionability | There are zero concrete instructions, no code examples, no commands, no templates, and no specific guidance on how to actually create an API reference. Every bullet point is abstract and vague. | 1 / 3 |
Workflow Clarity | There is no workflow whatsoever—no steps, no sequence, no validation checkpoints. The skill claims to provide 'step-by-step guidance' but contains none. | 1 / 3 |
Progressive Disclosure | The content is a monolithic block of generic text with no references to supporting files, no structured navigation, and no bundle files to support it. There is no meaningful content to organize. | 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
3a2d27d
- 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.