CtrlK
BlogDocsLog inGet started
Tessl Logo

api-documentation

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

68

1.11x
Quality

54%

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

50%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 skill is well-structured and token-efficient but lacks executable guidance and validation checkpoints, and its phase model depends on skills that do not exist in the bundle, undermining actionability and progressive disclosure.

Suggestions

Replace vague action bullets with concrete, executable guidance: example OpenAPI snippet, a real command, or a template the user can run.

Add explicit validation checkpoints in each phase (e.g. 'Verify the OpenAPI spec lints with `redocly lint` before proceeding') and turn Quality Gates into validate-then-proceed steps.

Either ship the referenced skills as real bundle files under references/scripts, or remove the dependency on them and inline the actual instructions, so progressive disclosure is grounded in real artifacts.

DimensionReasoningScore

Conciseness

The body is lean and avoids explaining concepts Claude already knows, using short bullet lists and terse phase descriptions; only minor repetition between 'When to Use' and the Overview could be trimmed.

4 / 5

Actionability

Actions are high-level hints ('Inventory endpoints', 'Create OpenAPI schema') with no executable code or commands, and the copy-paste prompts just reference skills that are not part of the bundle, leaving the user without concrete steps.

2 / 5

Workflow Clarity

Seven phases give a recognizable sequence and Quality Gates, but validation checkpoints are absent and the gates are loose checklists rather than explicit validate-then-proceed steps.

3 / 5

Progressive Disclosure

Content is organized into sections, but everything lives in a single monolithic SKILL.md with no references/scripts/assets bundle files, and the referenced skills (e.g. api-documenter, openapi-spec-generation) are not real files in the bundle.

3 / 5

Total

12

/

20

Passed

Description

58%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 conveys concrete capabilities clearly but omits any explicit trigger guidance for when Claude should invoke it, capping completeness. Trigger term coverage is decent but missing common synonyms.

Suggestions

Add an explicit 'Use when ...' clause listing concrete triggers (e.g., when the user asks for OpenAPI specs, developer guides, or API portals).

Broaden trigger terms with natural synonyms users actually say: 'API docs', 'Swagger', 'OpenAPI spec', '.yaml/.json spec files'.

Tighten the close ('maintaining comprehensive API documentation') which partially restates the opening, to sharpen distinctiveness.

DimensionReasoningScore

Specificity

Names the domain and several concrete actions ('generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation'), with only minor coverage gaps around interactive docs or portals.

4 / 5

Completeness

Provides a clear 'what' but lacks any explicit 'when'/'Use when...' trigger clause, which per the rubric caps completeness at 3.

3 / 5

Trigger Term Quality

Includes relevant terms like 'API documentation', 'OpenAPI specs', and 'developer guides', but omits common natural variations users would say such as 'API docs', 'Swagger', or file extensions like '.yaml'.

3 / 5

Distinctiveness Conflict Risk

The OpenAPI/developer-guide framing is mostly distinct from generic documentation skills, with only minor overlap risk against broad 'documentation' workflows.

4 / 5

Total

14

/

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.

Validation15 / 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
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.