Generate comprehensive documentation for this codebase:
[PASTE CODE HERE]
Language: [LANGUAGE]
Provide:
1. **README.md**: Project overview, installation, usage, configuration, API reference, contributing guide
2. **JSDoc/Docstring Comments**: For every public function, class, and method
3. **Architecture Overview**: How the codebase is organized and why
4. **API Documentation**: Every endpoint with params, responses, and examples
5. **Environment Variables**: All required env vars with descriptions and defaults
6. **Deployment Guide**: Step-by-step for local, staging, and production
7. **Changelog Template**: How to maintain a changelog going forward
8. **Troubleshooting Guide**: Common issues and their fixes
Generate comprehensive documentation for this codebase:
[PASTE CODE HERE]
Language: [LANGUAGE]
Provide:
1. **README.md**: Project overview, installation, usage, configuration, API reference, contributing guide
2. **JSDoc/Docstring Comments**: For every public function, class, and method
3. **Architecture Overview**: How the codebase is organized and why
4. **API Documentation**: Every endpoint with params, responses, and examples
5. **Environment Variables**: All required env vars with descriptions and defaults
6. **Deployment Guide**: Step-by-step for local, staging, and production
7. **Changelog Template**: How to maintain a changelog going forward
8. **Troubleshooting Guide**: Common issues and their fixes
How to use this prompt
Copy the prompt above and paste it into ChatGPT, Claude, Gemini, or any AI assistant. Replace the bracketed placeholders with your specific details.
Leave a Review
Tried this prompt? Let us know how it worked — your reviews help other users find the best prompts.