CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals.

Quality

55%

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 ./skills/api-documenter/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

25%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 persona resumé: extensive capability lists, behavioral traits, and a knowledge base that restate what Claude already knows, while providing almost no executable guidance. The strongest content is the final operational paragraph about tracing routes, verifying examples against mocks, and sandboxing try-it-now requests. The file is a single monolithic inline document with no progressive disclosure.

Suggestions

Cut 'Purpose', 'Behavioral Traits', 'Knowledge Base', and the capability catalogs; keep only instructions that add knowledge Claude lacks, such as the final operational paragraph.

Add at least one concrete, executable artifact per major task, e.g. a minimal valid OpenAPI 3.1 YAML skeleton with an auth scheme, or a redocly/Swagger CLI command for validating a spec.

Turn the Instructions into a real sequence with validation checkpoints (e.g. validate the spec -> fix errors -> re-validate -> only then generate SDKs/portal), mirroring the sandbox/verification guidance in the final paragraph.

DimensionReasoningScore

Conciseness

Roughly 130 of 183 lines are padded sections ('Behavioral Traits', 'Knowledge Base', 'Purpose', capability catalogs) that enumerate knowledge Claude already has without adding non-obvious detail. It stops short of score 1 because it enumerates rather than explains known concepts, and short of score 3 because the padding is pervasive, not incidental.

2 / 5

Actionability

Instructions and the Response Approach are high-level directives ('Create or validate specifications with examples and auth flows') with no executable code, commands, or tool usage; only the final paragraph gives concrete, specific guidance (trace route/auth/serializer, synthetic data, sandbox default, mark unexecuted examples). This matches 'minimal concrete guidance; high-level hints but missing specific steps' rather than score 3, which requires at least some concrete executable detail.

2 / 5

Workflow Clarity

Two numbered step lists exist but are abstract ('Assess documentation needs', 'Design information architecture') with no validation checkpoints or feedback loops; the only risk handling is the sandbox warning for state-mutating try-it-now requests. The steps are too poorly defined to fit anchor 3's 'steps listed with validation gaps'.

2 / 5

Progressive Disclosure

No bundle files exist (references/, scripts/, assets/ are absent) and the entire capability catalog is inlined in one 183-line file with zero offloading. It is not score 3 because that anchor requires references to be present, and not score 1 because section headers keep the file navigable.

2 / 5

Total

8

/

20

Passed

Description

66%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.

The description communicates a clear niche and several concrete actions, with decent natural trigger terms. Its main defect is the complete absence of an explicit 'Use when' clause, which caps completeness, plus some buzzword padding ('AI-powered tools', 'modern developer experience practices').

Suggestions

Add an explicit trigger clause, e.g. 'Use when the user asks to create or update OpenAPI/AsyncAPI specs, build developer portals, generate SDKs from specs, or improve API docs.'

Replace vague phrases like 'AI-powered tools' and 'modern developer experience practices' with the concrete actions those cover.

Include a few more natural synonyms users actually say, such as 'Swagger', 'REST API reference', or 'API spec'.

DimensionReasoningScore

Specificity

Concrete verbs are present ('Create interactive docs, generate SDKs, and build comprehensive developer portals') but 'AI-powered tools' and 'modern developer experience practices' are vague filler that name nothing specific.

4 / 5

Completeness

The 'what' is clear (create interactive docs, generate SDKs, build developer portals), but there is no 'Use when...' clause or any equivalent explicit trigger guidance, capping completeness at 3 per the rubric guideline.

3 / 5

Trigger Term Quality

Good natural keyword coverage ('API documentation', 'OpenAPI', 'SDKs', 'developer portals', 'interactive docs'), but misses common variations users say such as 'Swagger', 'REST API docs', or 'spec'.

4 / 5

Distinctiveness Conflict Risk

The API-documentation/OpenAPI/SDK niche is mostly distinct with clear triggers; only minor overlap risk with generic technical-writing or standalone SDK-generation skills.

4 / 5

Total

15

/

20

Passed

Validation

93%

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

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository

sickn33/agentic-awesome-skills

Path

skills/api-documenter/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.