Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →onewave-ai/api-documentation-writer
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials.
Passed 21 of 22 test cases with the skill, and 19 of 22 without it.
and 2 more in the full report
3 fixed18 passed either way0 still failing1 broke
Tokens, turns and time describe resource use, not a dollar price.
One of 3 test cases the skill fixed. Same model, same prompt, with and without the skill.
Can you create technical API documentation for our GraphQL API? It includes queries for retrieving user profiles and mutations for updating notification preferences. Please structure the documentation to include schema details, sample queries and mutations with realistic mock data, and guidance on authentication and rate limits.
| Checked | Without skill | With skill |
|---|---|---|
| The documentation provides cURL code samples for the GraphQL operations. | Missed | Passed |
| The documentation provides JavaScript code samples for the GraphQL operations. | Missed | Passed |
| The documentation provides Python code samples for the GraphQL operations. | Missed | Passed |
The instructions your model reads when the skill loads.
Generate comprehensive, developer-friendly API documentation.
references/documentation-structure.md — every section to cover (overview, auth, endpoints, errors, rate limits, SDKs, webhooks, GraphQL)references/output-template.md — canonical REST Markdown template with worked examplesreferences/best-practices.md — best practices, developer-experience tips, and the output quality checklistGather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and versioning strategy, available endpoints and their purposes, request/response formats, and any rate limiting or usage restrictions.
Build the documentation structure. Cover every section in references/documentation-structure.md, ordering the most common operations first.
Generate the output. Follow references/output-template.md for REST APIs; adapt to schema, query, mutation, and subscription examples for GraphQL. Replace all placeholders with realistic example data and show both request and response.
Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers to check, and how to handle 429 responses.
Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available.
Verify quality against the checklist in references/best-practices.md before delivering.
test cases passed, vs 19 / 22 without
Published skills whose descriptions closely match this one, with their headline benchmark lift.
More skills from the same source and nearby in the registry, with their headline benchmark lift.