Back to Engineering
Documentation
Professional Roles • Engineering
Technical Documentation
Project documentation
Create comprehensive technical documentation for [component/system]: Code/System: [description or code] Include: - Overview and purpose - Architecture diagram (describe) - Setup instructions - API/Interface documentation - Usage examples - Configuration options - Troubleshooting guide - Contributing guidelines Format in Markdown.
Try this prompt in:
Note: ChatGPT and Perplexity will open with the prompt pre-filled. For Claude and Gemini, you'll need to paste the prompt manually.
API Documentation Generator
API documentation
Generate API documentation for these endpoints: [Paste code or describe endpoints] For each endpoint provide: - Method and path - Description - Request parameters (path, query, body) - Request example (curl and code) - Response schema - Response examples (success and error) - Authentication requirements - Rate limiting - Common error codes
Try this prompt in:
Note: ChatGPT and Perplexity will open with the prompt pre-filled. For Claude and Gemini, you'll need to paste the prompt manually.
