CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-documentation

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

1.11x
Quality

64%

Does it follow best practices?

Impact

95%

1.11x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./plugins/AI-Agents-Safe-Coding-Skills-claude/skills/api-documentation/SKILL.md

The canonical home for this skill is api-documentation in sickn33/agentic-awesome-skills

SKILL.md
Quality
Evals
Security

Quality

Content

46%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 lays out a clear, well-organized 7-phase workflow but operates almost entirely at the level of vague verb phrases — no commands, code, tools, or concrete steps anywhere. Repetitive per-phase scaffolding dilutes token efficiency, and validation exists only as a coarse end-of-work checklist.

Suggestions

Add one concrete, executable artifact per phase (e.g., a real command, snippet, or tool invocation such as 'spectral lint openapi.yaml' for the OpenAPI phase) so the actions are more than verb phrases.

Insert validation checkpoints with feedback loops (e.g., 'Validate the OpenAPI spec before writing the developer guide; fix and re-validate on failure') instead of only an end-of-work Quality Gates list.

Collapse the repetitive 'Skills to Invoke / Actions / Copy-Paste Prompts' scaffolding — e.g., merge trivial prompts into the action lists — to cut padding like '- `documentation` - Documentation'.

DimensionReasoningScore

Conciseness

The body does not explain concepts Claude already knows, but it repeats the same 'Skills to Invoke / Actions / Copy-Paste Prompts' scaffolding across all 7 phases, and entries like '- `api-documenter` - API documentation' or '- `documentation` - Documentation' are padding that could be collapsed. Mostly efficient but could be tightened, matching anchor 3.

3 / 5

Actionability

Actions are high-level verb phrases ('Inventory endpoints', 'Define paths', 'Configure validation') with no commands, code, file paths, tools, or specific steps; the copy-paste prompts are trivial one-liners that add no executable guidance. This matches anchor 2 — high-level hints missing the specific steps to execute — rather than 3, since there is no concrete (even pseudocode-level) guidance.

2 / 5

Workflow Clarity

A clear 7-phase sequence exists and the Quality Gates checklist provides a coarse end-state check, but there are no per-phase validation checkpoints and no feedback loops (e.g., verifying the generated OpenAPI spec validates before building guides on it). Steps are listed with implicit checkpoints only, matching anchor 3.

3 / 5

Progressive Disclosure

The body is well-organized with clear section headers, and the skill is self-contained with no bundle files (references/, scripts/, assets/ are absent) and no buried or nested references. Good structure with minor organization gaps from repetitive per-phase scaffolding — anchor 4; not a 5 because there is no navigation to deeper material and the repetition slightly hinders scanning.

4 / 5

Total

12

/

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 clearly states what the skill does with two concrete, domain-specific actions, but it lacks any 'when to use' trigger clause, which caps completeness and limits its discoverability. It also misses natural synonyms such as 'Swagger' or 'API reference' that users commonly say.

Suggestions

Add an explicit trigger clause, e.g. 'Use when the user asks to document an API, generate an OpenAPI/Swagger spec, or write developer guides.'

Include common synonyms and variations such as 'Swagger', 'API reference', and 'API docs' to broaden natural trigger coverage.

Replace the circular phrase 'maintaining comprehensive API documentation' with concrete deliverables like 'setting up interactive docs (Swagger UI/Redoc) and code examples' to sharpen specificity.

DimensionReasoningScore

Specificity

Names the domain and lists concrete actions ('generating OpenAPI specs, creating developer guides'), but the third action ('maintaining comprehensive API documentation') merely restates the domain, leaving minor coverage gaps (no mention of code examples or interactive docs). Falls between anchor 3 (1-2 concrete actions) and anchor 4 (several specific actions) — closer to 4 since two actions are genuinely specific.

4 / 5

Completeness

The 'what' is clear (generate OpenAPI specs, create developer guides, maintain API documentation), but there is no 'Use when...' clause or any equivalent explicit trigger guidance — the 'when' is entirely absent. Per the judging guideline, a missing 'Use when' clause caps completeness at 3.

3 / 5

Trigger Term Quality

Includes natural phrases users would say ('API documentation', 'OpenAPI specs', 'developer guides'), but misses common synonyms and variations like 'Swagger', 'API reference', or 'write API docs'. Good coverage with a few natural terms missing matches anchor 4; not comprehensive enough for 5.

4 / 5

Distinctiveness Conflict Risk

'API documentation workflow' with OpenAPI/developer-guide triggers carves a mostly distinct niche with minor overlap risk against generic documentation skills. Not a 5 because 'API documentation' alone could also trigger broader documentation 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

administrakt0r/AI-Agents-Safe-Coding-Skills

Path

plugins/AI-Agents-Safe-Coding-Skills-claude/skills/api-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.