Documentation Prompts

Write a README.md for this project: [describe project or paste code]. Include: Project title and description, installation instructions, usage examples with code, configuration options, contributing guidelines, and license. Make it scannable.

Generate API documentation for these endpoints: [paste routes/handlers]. For each endpoint include: HTTP method and path, description, request parameters, request body schema, response schema, example request/response, and error codes.

Write documentation for this function: [paste function]. Include: purpose, parameters with types and descriptions, return value, exceptions thrown, usage example, and edge cases to be aware of. Use [JSDoc/Python docstring/etc.] format.

Document the architecture of this system: [describe or paste key code]. Create: high-level overview, component descriptions, data flow explanation, key design decisions and their rationale, and a diagram description (for Mermaid/PlantUML).

Add inline comments to this code to explain complex logic: [paste code]. Don't comment obvious things. Focus on: why decisions were made, non-obvious side effects, performance considerations, and anything that confused you when writing it.

Write a migration guide for users upgrading from [old version] to [new version]. Include: breaking changes, new features, step-by-step upgrade instructions, configuration changes needed, and common issues with solutions.