All prompts
9 results · tag chatgpt-technical-documentation-writing
3. Review and Refinement
Review and improve this documentation section: [Paste existing documentation] Please: 1. Check for technical accuracy 2. Improve clarity and readability 3. Add…
2. Drafting Phase
Create an initial draft for this documentation section: Section: Getting Started with the Notification SDK Audience: JavaScript developers Technical level: Int…
1. Planning Phase
Help me plan documentation for a new feature: Feature: Real-time notifications system Components: WebSocket server, client SDK, admin dashboard Users: Develope…
3. Troubleshooting Guides
Write a comprehensive troubleshooting guide for this error: Error: "Connection timeout: Unable to establish database connection" Context: Database connection i…
2. Version-Specific Documentation
Create a comprehensive migration guide: v1.0 -> v2.0 Migration Guide Changes: 1. Authentication header format (Bearer token required) 2. Response structure (ne…
1. Interactive Documentation
Create documentation for an interactive component: Component: Data visualization chart Library: Chart.js Features: Line, bar, and pie chart options Include: 1.…
Configuration Guide
Create a detailed configuration guide for this database connection: const dbConfig = { host: process.env.DB_HOST, port: process.env.DB_PORT, username: process.…
API Endpoint Documentation
Create detailed documentation for this REST API endpoint: Endpoint: POST /api/v1/users Description: Creates a new user account with email verification Request…
Basic Documentation Structure
Help me create comprehensive documentation for a user authentication module: Module features: - Email/password authentication - Social login integration (Googl…