api-documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals.

1.00x

Quality

50%

Does it follow best practices?

Impact

100%

1.00x

Average score across 3 eval scenarios

Securityby

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

The canonical home for this skill is api-documenter in rmyndharis/antigravity-skills

Quality

Content

35%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 reads as a persona brief — extensive capability lists and behavioral traits with no executable code, commands, or validation checkpoints. It is verbose and low on actionable guidance, with all content inlined rather than split across reference files.

Suggestions

Replace the capability/persona lists with concrete, executable guidance: an OpenAPI authoring snippet, an SDK generation command (e.g. openapi-generator-cli), and a spec-validation step.

Add validation checkpoints to the workflow (e.g. validate the OpenAPI spec with a linter before generating SDKs, and test generated code examples) to raise workflow clarity.

Move the long "Capabilities" and "Knowledge Base" catalogs into separate reference files and link to them from a concise SKILL.md overview to improve progressive disclosure and conciseness.

Dimension	Reasoning	Score
Conciseness	The body enumerates capabilities Claude already knows (OpenAPI 3.1, OAuth 2.0, Swagger UI, JWT handling) across padded "Capabilities", "Behavioral Traits", and "Knowledge Base" sections, adding persona bulk rather than novel, actionable information.	2 / 5
Actionability	There is no executable code or specific commands; the Instructions and Response Approach are high-level hints ("Create or validate specifications with examples and auth flows") missing the concrete steps and tooling needed to execute.	2 / 5
Workflow Clarity	A rough sequence exists via the 4-step Instructions and 8-step Response Approach, but there are no validation checkpoints or feedback loops for spec validation, SDK generation, or example testing.	3 / 5
Progressive Disclosure	Sections are organized under clear headers, but the ~175-line body is monolithic with no references to separate files and no bundle files; long capability catalogs that belong in reference files are inlined.	3 / 5
	Total	10 / 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 is specific and uses natural trigger terms within a distinct API-documentation niche, but it omits any explicit "Use when..." guidance, capping its completeness. Adding a trigger clause would lift the weakest dimension.

Suggestions

Append a "Use when..." clause naming concrete triggers, e.g. "Use when creating or updating OpenAPI/AsyncAPI specs, building developer portals or SDK docs, or generating SDKs from an API spec."

Add natural synonyms and file extensions (e.g. ".yaml", "spec", "Swagger", "Redoc") to broaden trigger-term coverage.

Tighten the opening "Master API documentation..." into a more concrete verb-led action to push specificity toward 5.

Dimension	Reasoning	Score
Specificity	"Create interactive docs, generate SDKs, and build comprehensive developer portals" names three concrete actions in the API-docs domain, but the opening "Master API documentation" is slightly abstract, leaving minor coverage gaps short of a 5.	4 / 5
Completeness	It clearly states what the skill does, but there is no "Use when..." clause or equivalent explicit trigger guidance, which per the rubric caps completeness at 3.	3 / 5
Trigger Term Quality	Natural phrases users would say appear ("API documentation", "OpenAPI 3.1", "interactive docs", "SDKs", "developer portals"), but common synonyms and file extensions like .yaml or "spec" are missing.	4 / 5
Distinctiveness Conflict Risk	The OpenAPI/SDK/developer-portal framing carves a clear niche with distinct triggers, with only minor overlap risk against general technical-writing or docs skills.	4 / 5
	Total	15 / 20 Passed

Validation

93%

Warnings & errors only

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

Validation — 15 / 16 Passed

Validation for skill structure

Criteria	Description	Result
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
Path: plugins/AI-Agents-Safe-Coding-Skills-claude/skills/api-documenter/SKILL.md
Commit: 900c504

Reviewed: 5 hours ago

Table of Contents

Discovery Implementation Validation

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.