Master API documentation with OpenAPI 3.1.
48
36%
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./.agent/skills/api-documenter/SKILL.mdQuality
Discovery
22%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 too brief and vague to effectively guide skill selection. It fails to specify concrete actions (generate, validate, convert specs?) and lacks any 'Use when' guidance. The OpenAPI 3.1 mention provides some distinctiveness but insufficient detail for Claude to confidently choose this skill.
Suggestions
Add specific concrete actions like 'Generate, validate, and parse OpenAPI 3.1 specifications; convert between YAML and JSON formats; create API documentation from specs'
Add explicit trigger guidance: 'Use when the user mentions OpenAPI, Swagger, API specs, REST API documentation, or .yaml/.json API definitions'
Include common user terminology variations: 'swagger', 'API spec', 'REST docs', 'API schema'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description uses vague language ('Master API documentation') without listing any concrete actions. It doesn't specify what operations can be performed (e.g., generate, validate, parse, convert). | 1 / 3 |
Completeness | The description weakly addresses 'what' (something about API documentation) but completely lacks a 'Use when...' clause or any explicit trigger guidance for when Claude should select this skill. | 1 / 3 |
Trigger Term Quality | Contains some relevant keywords ('API documentation', 'OpenAPI 3.1') but misses common variations users might say like 'swagger', 'API spec', 'REST API docs', '.yaml', '.json schema'. | 2 / 3 |
Distinctiveness Conflict Risk | The mention of 'OpenAPI 3.1' provides some specificity, but 'API documentation' is broad enough to potentially conflict with general documentation or API-related skills. | 2 / 3 |
Total | 6 / 12 Passed |
Implementation
50%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 reasonable high-level framework for API documentation but lacks the concrete, executable guidance needed for immediate action. It reads more like a checklist of best practices than a skill that enables Claude to perform specific tasks. The single executable command is a strength, but the majority of content is advisory rather than actionable.
Suggestions
Add concrete OpenAPI 3.1 schema examples showing proper typing, security schemes, and response definitions that can be copy-pasted
Include executable commands for SDK generation (e.g., actual openapi-generator-cli invocations with flags) and mock server setup
Add validation checkpoints to the Execution Protocol with specific success criteria and error recovery steps
Remove the persona framing ('You are a Senior Technical Writer') and decorative language to improve token efficiency
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content includes some unnecessary framing ('You are a Senior Technical Writer') and decorative elements (emojis, 'delight for developers'). The bullet points are reasonably efficient but could be tighter - phrases like 'documentation that isn't just a reference' add no actionable value. | 2 / 3 |
Actionability | Provides one concrete executable command (the validator script), but most guidance is abstract advice ('Use strict typing', 'Provide realistic examples', 'Write tutorials') rather than executable code or specific templates. Missing actual OpenAPI schema examples or concrete implementation patterns. | 2 / 3 |
Workflow Clarity | The Execution Protocol provides a 4-step sequence, but lacks validation checkpoints between steps. Step 1 validates the spec, but there's no feedback loop if validation fails, and steps 2-4 are vague ('Use standard templates', 'Audit the documentation') without concrete verification criteria. | 2 / 3 |
Progressive Disclosure | Has clear section organization with an internal menu, but all content is inline rather than appropriately split. References a script path but doesn't link to additional detailed resources for SDK generation, schema examples, or template files that would benefit from separate documentation. | 2 / 3 |
Total | 8 / 12 Passed |
Validation
90%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 10 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 10 / 11 Passed | |
332e58b
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.