Api Reference Creator - Auto-activating skill for Technical Documentation. Triggers on: api reference creator, api reference creator Part of the Technical Documentation skill category.
34
0%
Does it follow best practices?
Impact
100%
1.00xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./planned-skills/generated/17-technical-docs/api-reference-creator/SKILL.mdREST API reference documentation
Markdown format
100%
100%
All endpoints documented
100%
100%
HTTP methods shown
100%
100%
Path parameters documented
100%
100%
Query parameters documented
100%
100%
Request body documented
100%
100%
Required fields noted
100%
100%
Response codes documented
100%
100%
Response body documented
100%
100%
Code examples present
100%
100%
Document structure
100%
100%
Documentation automation from source
Shell script produced
100%
100%
Script uses Grep/Bash to read source
100%
100%
Script reads src/ directory
100%
100%
Script writes docs/api-reference.md
100%
100%
Generated doc is markdown
100%
100%
All 5 functions documented
100%
100%
JSDoc descriptions included
100%
100%
Parameters documented
100%
100%
Return types documented
100%
100%
Production-ready script
100%
100%
User guide technical writing
Markdown format
100%
100%
Step-by-step structure
100%
100%
Installation section
100%
100%
Authentication documented
100%
100%
send() method covered
100%
100%
send_batch() covered
100%
100%
get_status() covered
100%
100%
Message length constraint
100%
100%
Batch size constraint
100%
100%
Error handling noted
100%
100%
Code blocks in Python
100%
100%
b8a3b3e
Table of Contents
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.