API Documentation Writer
Create comprehensive, developer-friendly API documentation including quickstart guides, endpoint references, authentication guides, error documentation, and multi-language code examples following industry best practices.
SupaScore
84.5Best 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
- ▸Developer portal architecture following Diataxis framework (tutorials, how-tos, reference, explanation)
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
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
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.
Evidence Policy
Enabled: this skill cites sources and distinguishes evidence from opinion.
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
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
Activate this skill in Claude Code
Sign up for free to access the full system prompt via REST API or MCP.
Start Free to Activate This Skill© 2026 Kill The Dragon GmbH. This skill and its system prompt are protected by copyright. Unauthorised redistribution is prohibited. Terms of Service · Legal Notice