CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-reference-documentation

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.

55

Quality

69%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

36%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body reads as a generic OpenAPI reference sample plus common-knowledge best practices rather than skill-specific instruction. It lacks any documented workflow for creating the documentation and pads context with a large YAML example Claude could produce unaided.

Suggestions

Replace the generic OpenAPI YAML sample with skill-specific guidance: a documented sequence for producing docs (gather endpoints → define security schemes → draft spec → render/validate with Swagger UI or Redoc) with concrete commands.

Move the full OpenAPI template and per-endpoint example patterns into a references/ file (e.g., references/template.yaml), keeping only a brief pointer in SKILL.md to cut the inline token cost.

Turn the unchecked checklist into an explicit validation step at the end of the workflow (e.g., 'before delivering, verify each checklist item against the generated spec') so completion has a feedback loop.

DimensionReasoningScore

Conciseness

The ~55-line generic e-commerce OpenAPI YAML template and the 'Best Practices' list ('Use OpenAPI 3.0+ specification', 'Include request/response examples') restate knowledge Claude already has, with no skill-specific guidance added. This is noticeable padding across multiple sections rather than the isolated instances a 3 would allow.

2 / 5

Actionability

The YAML block is a concrete, syntactically valid template a model can copy, but there are no commands, tool invocations, or instructions for actually producing the documentation — key execution details are missing. More concrete than the high-level hints of a 2, but not the copy-paste-ready operational guidance of a 4.

3 / 5

Workflow Clarity

At best an implicit rough shape exists (write spec → apply checklist → pick a tool), but no steps are sequenced or defined. The checklist hints at validation ('All endpoints documented', 'Error responses specified') yet no validation process is described, matching 'rough sequence present but many gaps; validation absent'.

2 / 5

Progressive Disclosure

Section headers give the body some structure, but the large OpenAPI template is inlined where a references/ file (e.g., a house-style template or per-endpoint examples) would be appropriate, and there are no bundle files or references to navigate. Not the buried-structure-free-for-all of a 2, but short of the well-placed splits of a 4.

3 / 5

Total

10

/

20

Passed

Description

87%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A well-formed description: third person, concrete, with an explicit 'Use when' clause containing natural trigger phrases. Minor gaps in keyword synonyms (Swagger, API docs) are the only weakness.

DimensionReasoningScore

Specificity

Phrases like 'Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples' name the domain and several concrete capability areas. Falls short of 5 because 'creates documentation' is a single action whose scope (e.g., error schemas, versioning) is only implied, but exceeds 3 since multiple specific aspects are enumerated.

4 / 5

Completeness

It explicitly answers both questions: the 'what' ('Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples') and a concrete 'Use when...' clause with three trigger phrases, matching the top anchor exactly.

5 / 5

Trigger Term Quality

'documenting REST APIs, creating SDK references, or building developer portals' are natural phrases a user would say. A few natural synonyms are missing (e.g., 'Swagger', 'API docs', 'OpenAPI spec'), so it does not reach the comprehensive synonym/extension coverage of a 5.

4 / 5

Distinctiveness Conflict Risk

'OpenAPI specifications' and the trigger phrases (SDK references, developer portals, documenting REST APIs) carve out a clear niche with minimal overlap with adjacent writing/documentation skills.

5 / 5

Total

18

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

secondsky/claude-skills

Path

plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md

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.