CtrlK
BlogDocsLog inGet started
Tessl Logo

api-documentation-generator

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

71

1.11x
Quality

56%

Does it follow best practices?

Impact

99%

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-generator/SKILL.md

The canonical home for this skill is api-documentation-generator 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 is rich with concrete, reusable documentation templates but suffers from significant verbosity, redundant sections, and a monolithic structure that inlines content better split across reference files. The workflow lacks the verification checkpoints its own pitfall list calls out.

Suggestions

Move the large example templates (REST/GraphQL/OpenAPI/Postman) into separate reference files under references/ and link to them one level deep from SKILL.md.

Add an explicit validation/verification step to the workflow (e.g., 'Test every code example against a live endpoint' and 'Re-check examples against code before publishing').

Cut redundant sections — 'Common Pitfalls' duplicates 'Best Practices'/'Don't Do This', and the Tools and Formats section explains OpenAPI/Postman concepts Claude already knows.

DimensionReasoningScore

Conciseness

The ~480-line body is noticeably verbose: 'Common Pitfalls' rehashes 'Best Practices'/'Don't Do This', the Tools section explains OpenAPI/Postman basics Claude already knows, and first-person padding ('I'll examine', 'I'll create') inflates the How It Works section.

2 / 5

Actionability

Provides concrete, copy-paste-ready templates (cURL/JavaScript/Python requests, OpenAPI YAML, Postman JSON, GraphQL query) that cover common cases, with only minor gaps around real validation rules and response-header specifics.

4 / 5

Workflow Clarity

Five clearly sequenced steps (Analyze → Generate → Add Guidelines → Document Errors → Create Examples) are present, but there are no validation checkpoints such as verifying examples run or that docs stay in sync with code, even though the skill's own Common Pitfalls warns about exactly these failures.

3 / 5

Progressive Disclosure

No bundle files exist and the entire skill is a monolithic inline document; the large endpoint/GraphQL/OpenAPI/Postman template blocks clearly belong in separate reference files but are all inlined in SKILL.md with no external navigation.

2 / 5

Total

11

/

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 gives a clear, specific statement of what the skill does but omits any explicit 'when to use' trigger guidance, which caps its completeness. It is specific and reasonably distinct but not optimally triggerable.

Suggestions

Add an explicit 'Use when...' clause naming trigger phrases, e.g. 'Use when documenting a REST/GraphQL API, creating OpenAPI/Swagger specs, or when the user asks to document endpoints.'

Include natural synonyms and file extensions users say ('REST API', 'OpenAPI', 'Swagger', '.yaml/.json specs') to broaden trigger-term coverage.

Tighten the claim 'comprehensive, developer-friendly' which reads as mild marketing fluff; lead with the concrete actions instead.

DimensionReasoningScore

Specificity

Names the domain (API documentation) and several concrete actions — 'endpoints, parameters, examples, and best practices' — but stops short of the comprehensive multi-action coverage of a 5.

4 / 5

Completeness

Clearly states what the skill does ('Generate comprehensive, developer-friendly API documentation from code...') but provides no 'Use when...' clause or equivalent explicit trigger guidance, capping completeness at 3 per the rubric guideline.

3 / 5

Trigger Term Quality

Includes natural terms a user would say ('API documentation', 'endpoints', 'parameters', 'examples') with good coverage, though common variations like 'OpenAPI/Swagger', 'REST API', or 'document my API' are absent.

4 / 5

Distinctiveness Conflict Risk

The 'API documentation from code' niche is mostly distinct with clear triggers; minor overlap risk only with closely related doc/copywriting skills rather than a broad conflict.

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.