Technical Documentation Template
ChatGPT Prompt
Create a technical documentation template for [API/LIBRARY]. Include overview, installation, configuration, usage examples, API reference, troubleshooting, and contribution guidelines.
💡 Pro Tip: Replace placeholders in [BRACKETS] with your specific information for best results.
How to Use This Prompt
- 1Click the copy button above to copy the prompt to your clipboard
- 2Open ChatGPT, Claude, or your preferred AI assistant
- 3Paste the prompt and replace any [PLACEHOLDER TEXT] with your specific details
- 4Review the AI's response and iterate if needed for better results
Related Tags
Related Prompts
Unit Tests for {function}
Write comprehensive unit tests for the following TypeScript function. Include test cases for normal operation, edge cases, error conditions, and boundary values: [PASTE YOUR FUNCTION HERE]
Microservices Architecture Design
Design a microservices architecture for [APPLICATION TYPE]. Include service boundaries, communication patterns, data management, deployment strategy, and monitoring approach.
Clinical Documentation for minor surgery
Create a clinical documentation template for minor surgery. Include pre-procedure checklist, informed consent points, procedure steps, post-procedure monitoring, and discharge instructions.
API Design for booking
Design a RESTful API for a booking application. Include endpoint definitions, request/response schemas, authentication methods, error handling, and API documentation structure.
Database Schema for e-commerce
Create a normalized database schema for a e-commerce system. Include tables, relationships, indexes, constraints, and sample queries for common operations.
Code Review for TypeScript Application
Review the following TypeScript code for best practices, security vulnerabilities, performance optimization, and maintainability. Provide specific recommendations and refactored code examples: [PASTE YOUR CODE HERE]