Create API Documentation From Code
When you need professional documentation for your codebase to share with team or users.
Prompt
Given the following [LANGUAGE] code with function signatures and comments, produce comprehensive API documentation in [FORMAT, e.g., Markdown, OpenAPI]. Include descriptions, parameter details, return values, exceptions, and usage examples. Code: [CODE WITH COMMENTS]
Fill in these
Swap each placeholder for your own value:
[LANGUAGE][FORMAT][CODE WITH COMMENTS]
Pro tips
- Pre-annotate your code with structured comments (e.g., JSDoc, docstrings) for best results.
- Specify the audience (developers, external partners) to tailor the level of detail.
Related prompts
Diagnose And Fix Runtime Errors
You are an expert debugger. Given the following [LANGUAGE] code snippet that throws a runtime error, analyze the code, identify the root cause of the error, explain why it occurs, and provide a corrected version with explanation. Code snippet: [CODE SNIPPET] Error message: [ERROR MESSAGE] (if available).
View promptComprehensive Code Review Checklist
Act as a senior software engineer conducting a code review. Review the following [LANGUAGE] code focusing on: readability, maintainability, performance, security, and adherence to best practices. Provide a line-by-line review with specific, actionable feedback. Code: [CODE SNIPPET]
View promptModern Refactoring Of Legacy Code
You are a refactoring expert. Given the following legacy [LANGUAGE] code, refactor it to modern best practices and patterns. Use clear naming, reduce complexity, eliminate duplication, and apply appropriate design patterns if necessary. Explain your changes step-by-step. Code: [LEGACY CODE]
View promptDesign Scalable System Architecture
As a solution architect, design a high-level system architecture for the following requirements: [REQUIREMENTS]. Include key components, data flow, technology choices, and trade-offs. Explain how it meets scalability, reliability, and performance needs. Provide a diagram in text format (using ASCII art or simple blocks).
View prompt