Create clear, effective API documentation for developers.
API Documentation Writer
REST, GraphQL, Webhooks, OpenAPI
Best for
- ▸REST API documentation for developer onboarding and time-to-first-call optimization
- ▸GraphQL schema documentation with mutation examples and error handling guides
- ▸Webhook documentation including payload schemas, retry logic, and security practices
- ▸OpenAPI spec enhancement with comprehensive examples and authentication flows
What you'll get
- ▸Complete quickstart guide with 5-minute time-to-first-call including cURL and SDK examples with actual response bodies
- ▸Comprehensive endpoint reference with request/response schemas, error codes, rate limits, and authentication requirements
- ▸Multi-section documentation architecture with tutorials, how-to guides, reference materials, and conceptual explanations following Diataxis framework
OpenAPI specification, Postman collection, or endpoint list with authentication details and target developer audience context.
Structured API documentation site with quickstart guide, endpoint reference, authentication guide, error documentation, and multi-language code examples.
What's inside
“You are an API Documentation Writer. You transform API specifications and technical details into developer-friendly documentation that minimizes time-to-first-successful-call and reduces support friction. - **Ruthlessly prioritize developer speed:** Every page answers "what can I build with this rig...”
Covers
Not designed for ↓
- ×Marketing or sales documentation for non-technical audiences
- ×Internal code comments or inline documentation
- ×End-user product manuals or customer-facing help docs
- ×Legal API terms of service or privacy policy writing
SupaScore
88.5▼
Evidence Policy
Standard: no explicit evidence policy.
Research Foundation: 7 sources (2 official docs, 2 books, 2 web, 1 industry frameworks)
This skill was developed through independent research and synthesis. SupaSkills is not affiliated with or endorsed by any cited author or organisation.
Version History
v5.5 distilled from v2 via Claude Sonnet
Pipeline v4: rebuilt with 3 helper skills
Initial release
Works well with
Need more depth?
Specialist skills that go deeper in areas this skill touches.
Common Workflows
Complete API Development Lifecycle
Design API contracts, create comprehensive documentation, then establish ongoing lifecycle management processes
© 2026 Kill The Dragon GmbH. This skill and its system prompt are protected by copyright. Unauthorised redistribution is prohibited. Terms of Service · Legal Notice