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".

53

Quality

43%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./plugins/api-development/api-documentation-generator/skills/generating-api-docs/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Discovery

67%

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 covers the basics adequately with explicit 'what' and 'when' clauses, which is its strongest aspect. However, it suffers from somewhat circular language ('comprehensive API documentation' appears in both the capability statement and the 'Use when' clause), and the trigger terms lack breadth to capture the variety of ways users might request this skill. The specificity of concrete actions could be improved.

Suggestions

Expand trigger terms to include common variations like 'REST API', 'API reference', 'endpoint docs', 'OpenAPI', 'swagger', and 'SDK generation'.

Make the 'Use when' clause more distinct from the capability statement—instead of repeating 'comprehensive API documentation', describe specific scenarios like 'Use when documenting REST endpoints, generating SDK examples, or creating authentication/authorization guides for an API'.

Add more specific concrete actions such as 'generate endpoint references, request/response schemas, error code tables, and code samples in multiple languages'.

DimensionReasoningScore

Specificity

Names the domain (API documentation) and mentions some deliverables (examples, authentication guides, SDKs), but the actions are not very concrete—'create comprehensive API documentation' is somewhat generic and doesn't detail specific operations like generating endpoint references, request/response schemas, or error code tables.

2 / 3

Completeness

Explicitly answers both 'what' (create API documentation with examples, authentication guides, and SDKs) and 'when' (with a 'Use when' clause and explicit trigger phrases), satisfying the completeness requirement.

3 / 3

Trigger Term Quality

Includes some natural trigger phrases like 'generate API docs', 'create API documentation', and 'document the API', but misses common variations users might say such as 'REST API', 'endpoint documentation', 'API reference', 'swagger', 'OpenAPI', or 'SDK docs'.

2 / 3

Distinctiveness Conflict Risk

While 'API documentation' is a reasonably specific niche, it could overlap with general documentation skills or code documentation skills. The triggers are somewhat narrow but the description doesn't clearly distinguish itself from broader documentation or technical writing skills.

2 / 3

Total

9

/

12

Passed

Implementation

20%

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

This skill reads more like a product requirements document than an actionable skill for Claude. It describes what should be built at a high level but provides no executable code, no concrete commands, no configuration templates, and no specific tool invocations. The content is verbose, explaining concepts Claude already understands, while failing to provide the concrete implementation details that would make it useful.

Suggestions

Add executable code examples: include actual Redoc CLI commands (e.g., `npx @redocly/cli build-docs openapi.yaml --output docs/index.html`), sample configuration YAML, and at least one complete code example template.

Remove explanatory padding about well-known concepts (CORS, OAuth2 flows, what Faker does) and replace with specific, copy-paste-ready snippets and commands.

Add validation checkpoints to the workflow: e.g., 'Run `npx @redocly/cli lint openapi.yaml` and fix all errors before proceeding' after step 1, and a link-checking step after documentation generation.

Convert the abstract examples section into at least one concrete, end-to-end worked example showing actual file contents and commands needed to generate documentation from a sample spec.

DimensionReasoningScore

Conciseness

The skill is verbose and padded with information Claude already knows. It explains what CORS is, what OAuth2 flows are, what Faker does, and lists obvious prerequisites like 'static site hosting.' The examples section describes well-known patterns (Stripe-style docs) without providing any executable code or configuration. Much of this could be cut in half.

1 / 3

Actionability

Despite being lengthy, the skill contains zero executable code, no concrete commands, no configuration snippets, and no copy-paste-ready examples. Every instruction is abstract ('Generate interactive documentation using Redoc', 'Create runnable code examples') without showing how. The examples section describes desired outcomes rather than providing actionable steps.

1 / 3

Workflow Clarity

The 8 steps provide a reasonable sequence for the overall process, but there are no validation checkpoints, no feedback loops for error recovery, and no verification steps between stages. For a complex multi-step documentation generation workflow involving spec auditing and deployment, the absence of validation gates is a significant gap.

2 / 3

Progressive Disclosure

The skill references external files (implementation.md, errors.md, examples.md) which is good progressive disclosure structure, and the output section clearly lists expected artifacts. However, the main body itself is a wall of text that could benefit from better organization—the inline error table and verbose examples section could be moved to referenced files, and the core SKILL.md kept leaner.

2 / 3

Total

6

/

12

Passed

Validation

81%

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

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

9

/

11

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.