API Documentation

Write API documentation that developers can use to integrate successfully — with clear authentication guides, endpoint references, code examples, and error handling.

Usage

Describe your API endpoints and target developers. The skill structures your documentation with authentication, quickstart, endpoint reference, error codes, and SDK examples.

Examples

• "Document a REST API with 15 endpoints for a payment processing service"
• "Write a quickstart guide that gets developers from API key to first successful call"
• "Create error code reference documentation with troubleshooting steps for each error"

Guidelines

• Start with a quickstart guide: authentication setup to first API call in under 2 minutes
• Document every endpoint with method, URL, parameters, request body, response, and error codes
• Provide code examples in at least 3 languages: curl, Python, and JavaScript or your users' primary language
• Include a complete error reference table with HTTP status codes, error messages, and resolution steps
• Version your docs alongside your API — outdated documentation is the top developer frustration