Api Reference Creator - Auto-activating skill for Technical Documentation. Triggers on: api reference creator, api reference creator Part of the Technical Documentation skill category.
Install with Tessl CLI
npx tessl i github:jeremylongshore/claude-code-plugins-plus-skills --skill api-reference-creatorOverall
score
17%
Does it follow best practices?
Validation for skill structure
Activation
0%This description is essentially a placeholder with no substantive content. It only provides the skill name, a redundant trigger term, and a category label without describing any actual capabilities or usage conditions. The description fails across all dimensions and would be ineffective for skill selection.
Suggestions
Add specific concrete actions the skill performs, such as 'Generates API reference documentation from code, creates endpoint descriptions, documents request/response schemas, and formats parameter tables'.
Include a 'Use when...' clause with natural trigger terms like 'Use when the user needs API documentation, endpoint references, REST API docs, swagger-style documentation, or asks to document an API'.
Add file type or technology triggers users might mention: 'OpenAPI', 'swagger', '.yaml API specs', 'REST endpoints', 'API endpoints documentation'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description contains no concrete actions - only the skill name 'Api Reference Creator' and category 'Technical Documentation'. There are no specific capabilities listed like 'generates endpoint documentation' or 'creates parameter tables'. | 1 / 3 |
Completeness | The description fails to answer both 'what does this do' (no actions described) and 'when should Claude use it' (no 'Use when...' clause or explicit trigger guidance). Only category metadata is provided. | 1 / 3 |
Trigger Term Quality | The trigger terms are just the skill name repeated twice ('api reference creator, api reference creator'). No natural user keywords like 'API docs', 'endpoint documentation', 'swagger', 'REST API', or 'documentation generation' are included. | 1 / 3 |
Distinctiveness Conflict Risk | The generic 'Technical Documentation' category and lack of specific triggers means this could easily conflict with any documentation-related skill. Nothing distinguishes it from general documentation tools. | 1 / 3 |
Total | 4 / 12 Passed |
Implementation
0%This skill is an empty template with no actual content about API reference creation. It contains only generic boilerplate text that could apply to any skill, providing zero actionable guidance, no examples, and no specific knowledge about creating API documentation.
Suggestions
Add concrete examples of API reference formats (OpenAPI/Swagger, JSDoc, etc.) with executable code showing how to generate them
Include a clear workflow for creating API references: extract endpoints -> document parameters -> add examples -> validate output
Provide specific templates or schemas for common API documentation patterns (REST endpoints, request/response examples, authentication sections)
Reference or link to detailed guides for different documentation tools (Swagger UI, Redoc, Slate) rather than generic claims about capabilities
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is padded with generic boilerplate that explains nothing specific about API reference creation. Phrases like 'provides automated assistance' and 'follows industry best practices' are meaningless filler that waste tokens. | 1 / 3 |
Actionability | No concrete guidance whatsoever - no code examples, no specific commands, no actual instructions on how to create API references. The content describes rather than instructs, with vague statements like 'Generates production-ready code' without showing any. | 1 / 3 |
Workflow Clarity | No workflow is defined. There are no steps, no sequence, no validation checkpoints. The skill claims to provide 'step-by-step guidance' but contains zero actual steps. | 1 / 3 |
Progressive Disclosure | No structure beyond generic headings. No references to detailed documentation, no examples file, no API reference format templates. The content is a shallow placeholder with no depth or navigation to additional resources. | 1 / 3 |
Total | 4 / 12 Passed |
Validation
69%Validation — 11 / 16 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
description_trigger_hint | Description may be missing an explicit 'when to use' trigger hint (e.g., 'Use when...') | Warning |
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
metadata_version | 'metadata' field is not a dictionary | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
body_steps | No step-by-step structure detected (no ordered list); consider adding a simple workflow | Warning |
Total | 11 / 16 Passed | |
Table of Contents
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.