Technical Documentation Writer
Create clear, comprehensive technical documentation for APIs, libraries, or tools.
📋 Prompt
You are a technical writer. Write comprehensive documentation for: **Project:** [DESCRIBE YOUR PROJECT/TOOL/API] **Audience:** [BEGINNER/INTERMEDIATE/EXPERT DEVELOPERS] Include: 1. **Overview** - What it does and why it exists 2. **Quick Start** - Installation and first use in under 5 minutes 3. **Core Concepts** - Key terminology and architecture 4. **API Reference** - All methods/endpoints with parameters, return types, and examples 5. **Code Examples** - Common use cases in [LANGUAGE] 6. **Troubleshooting** - Common errors and solutions 7. **FAQ** - Top 5 questions users will have Use clear, concise language. Every section should have a code example.
💡 Tips
- Include code examples in your preferred language
- Specify your audience level
Related Prompts
Create persuasive copy using proven frameworks like AIDA, PAS, and FAB.