CtrlK
BlogDocsLog inGet started
Tessl Logo

generating-api-docs

Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API".

64

Quality

78%

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-development/api-documentation-generator/skills/generating-api-docs/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

57%Weight 40%Scale 1-3

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

A well-structured, information-dense skill body with clear sequencing and excellent progressive disclosure via real reference files. Its main weaknesses are the absence of executable code/commands in the body itself and a lack of integrated validation/feedback checkpoints beyond the initial spec audit.

Suggestions

Add at least one copy-pasteable command for the core generation step (e.g., `redoc-cli bundle openapi.yaml -o docs/site/`) so the body is directly executable without opening implementation.md.

De-duplicate the documentation-generator list (Redoc, Stoplight Elements, Swagger UI) between the Overview and Prerequisites sections to recover tokens.

Insert an explicit post-generation validation checkpoint — verify the site builds and code examples run, with a fix-and-retry loop — rather than relying on the upfront spec audit alone.

DimensionReasoningScore

Conciseness

The body is mostly efficient and assumes Claude's competence, but the documentation-generator list is repeated between the Overview and Prerequisites sections and the overall length could be tightened.

2 / 3

Actionability

Steps name specific tools and per-language libraries (curl, fetch/axios, requests/httpx, net/http), but the body contains no executable code or commands — concrete detail is deferred to implementation.md.

2 / 3

Workflow Clarity

An explicit 8-step sequence is present with an upfront completeness audit in step 1, but there is no post-generation validation checkpoint or fix-and-retry feedback loop integrated into the workflow.

2 / 3

Progressive Disclosure

The body is a clear overview with well-signaled, one-level-deep references to real bundle files (implementation.md, errors.md, examples.md), with content appropriately split between the main file and references.

3 / 3

Total

9

/

12

Passed

Description

100%Weight 40%Scale 1-3

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-crafted description that concisely states the capability, provides explicit 'Use when' trigger guidance, and lists natural trigger phrases within a clearly distinct niche. No vague fluff or over-claims.

DimensionReasoningScore

Specificity

Lists concrete deliverables — 'examples, authentication guides, and SDKs' — matching the anchor for multiple specific concrete actions, rather than vague language.

3 / 3

Completeness

Explicitly answers both what ('Create comprehensive API documentation with examples, authentication guides, and SDKs') and when ('Use when creating comprehensive API documentation'), with explicit trigger guidance.

3 / 3

Trigger Term Quality

Provides natural phrases users would say — 'generate API docs', 'create API documentation', 'document the API' — giving good coverage of likely utterances.

3 / 3

Distinctiveness Conflict Risk

API documentation generation is a clear niche with distinct, specific triggers, making it unlikely to fire for unrelated skills.

3 / 3

Total

12

/

12

Passed

Validation

87%

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

Validation14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

frontmatter_unknown_keys

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

Warning

Total

14

/

16

Passed

Repository
jeremylongshore/claude-code-plugins-plus-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.