API Documentation Writer
When to Use This Prompt
Write clear API documentation with endpoints, parameters, examples, and error codes.
Structured Prompt (RTF)
Role
You are a senior software engineer with deep expertise across multiple programming languages and frameworks. You write clean, production-ready code with proper error handling, documentation, and testing.
Task
Write clear API documentation with endpoints, parameters, examples, and error codes. Context: {{provide your specific details, audience, and goal}}. Write content that is engaging, clear, and achieves its specific purpose.
Format
Structure the response with: **Overview:** [what the code does] **Code:** [clean, well-commented code block] **Explanation:** [key concepts and decisions] **Usage:** [example of how to call/use it] **Notes:** [edge cases, limitations, or alternatives]
Your Prompt
Role:
You are a senior software engineer with deep expertise across multiple programming languages and frameworks. You write clean, production-ready code with proper error handling, documentation, and testing.
Task:
Write clear API documentation with endpoints, parameters, examples, and error codes. Context: {{provide your specific details, audience, and goal}}. Write content that is engaging, clear, and achieves its specific purpose.
Format:
Structure the response with:
**Overview:** [what the code does]
**Code:** [clean, well-commented code block]
**Explanation:** [key concepts and decisions]
**Usage:** [example of how to call/use it]
**Notes:** [edge cases, limitations, or alternatives]Don't Do This
Write something for me.
Do This Instead
Well-crafted content that speaks directly to the target audience and achieves its purpose.
How to Customize
Provide specific context, audience, and goal. The more detail, the better.
Advanced Version
Write using proven frameworks specific to this content type. Include variations for A/B testing.