The Prompt
Write comprehensive technical documentation for [project/feature/API]. Documentation type: [API docs/README/Architecture doc/User guide] Audience: [developers/end users/both] Tech stack: [list technologies] Documentation should include: 1. OVERVIEW - What this does in one paragraph - Key features list - When to use this 2. PREREQUISITES - Required software and versions - Required knowledge - Access requirements 3. INSTALLATION/SETUP - Step by step instructions - Environment configuration - Common setup issues 4. QUICK START - Minimal working example - Code snippet to get started in 5 minutes 5. DETAILED USAGE - All features with examples - Configuration options - Code examples for each feature 6. API REFERENCE (if applicable) - Endpoints/methods - Parameters - Request/response examples - Error codes 7. TROUBLESHOOTING - Common errors and solutions - Debug tips 8. CONTRIBUTING - How to contribute - Code style guide - PR process 9. CHANGELOG 10. LICENSE Write in clear, concise technical English Include code examples in proper code blocks
Copied 1 times
How to Use This Prompt
- Click Copy Prompt above
- Open ChatGPT or Claude
- Paste the prompt and replace anything in [brackets] with your own details
- Press Enter and get your result instantly
Pro Tip
The more specific you are when replacing the [brackets], the better your result. For example instead of writing [Job Title] write "Senior Software Engineer with 5 years experience" — specificity is what separates a good AI response from a great one.
This prompt works best with ChatGPT . If you are not happy with the first result, try adding "make it more concise" or "give me 3 alternative versions" as a follow-up message.