CtrlK
BlogDocsLog inGet started
Tessl Logo

api-documentation

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

75

1.11x
Quality

63%

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

61%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 is a well-structured, lean 7-phase orchestration workflow, but its action lists are high-level rather than executable and it lacks inter-phase validation checkpoints, capping actionability and workflow clarity at 3.

Suggestions

Add concrete, executable detail for the key actions — e.g. a sample OpenAPI path/schema snippet, a curl example, or the exact command to launch Swagger UI — rather than only 'Add schemas' / 'Set up Swagger UI'.

Insert validation checkpoints between phases, e.g. after Phase 2 'Validate the OpenAPI spec with a linter before writing the developer guide', creating a validate→fix→retry loop.

Tighten the per-phase 'Skills to Invoke' descriptions beyond single words ('API documentation', 'API design') so each named skill's role is clear.

DimensionReasoningScore

Conciseness

Lean per-phase structure with short action lists and copy-paste prompts; assumes Claude knows OpenAPI/Swagger/Redoc. Minor trim opportunities in the repetitive phase template and one-word skill descriptions.

4 / 5

Actionability

Concrete guidance exists only via the copy-paste skill-invocation prompts; the action lists are high-level imperatives ('Inventory endpoints', 'Add schemas') missing the specific steps to execute, so guidance is incomplete.

3 / 5

Workflow Clarity

Seven phases are clearly sequenced with a final Quality Gates checklist, but there are no inter-phase validation checkpoints or feedback loops — validation is only an end-of-process gate, not per-phase.

3 / 5

Progressive Disclosure

Well-organized into clear sections (Overview, When to Use, Phases, Quality Gates, Related Bundles) with all content appropriately inline for an orchestration skill; no bundle files exist, and minor repetition across phases is the only gap.

4 / 5

Total

14

/

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 and names a specific niche with several concrete actions, but it lacks any explicit 'Use when...' trigger guidance, leaving the 'when' unanswered and capping completeness at 3.

Suggestions

Add an explicit 'Use when...' clause, e.g. 'Use when creating API docs, generating OpenAPI/Swagger specs, writing developer guides, or building API portals.'

Replace the generic 'maintaining comprehensive API documentation' with a concrete action such as 'maintaining API docs with auto-generation and validation'.

Include common synonyms users say naturally — 'Swagger', 'API reference', 'API docs' — to broaden trigger coverage.

DimensionReasoningScore

Specificity

Lists several concrete actions ('generating OpenAPI specs', 'creating developer guides') with a minor gap — 'maintaining comprehensive API documentation' is generic rather than a specific action.

4 / 5

Completeness

Has a clear 'what' but no 'when' — there is no 'Use when...' clause or equivalent explicit trigger guidance, which caps completeness at 3 per the rubric.

3 / 5

Trigger Term Quality

Includes natural terms users would say ('API documentation', 'OpenAPI specs', 'developer guides') but misses common synonyms like 'Swagger', 'API reference', or 'API docs'.

4 / 5

Distinctiveness Conflict Risk

Targets a specific API-documentation niche (OpenAPI specs, developer guides) and is mostly distinct, with only minor overlap risk against general '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.

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.