Technical Documentation Writer
Technical documentation template with quick start, API reference, and troubleshooting sections.
writingdocumentationtechnicalapi-docs
Prompt
Write clear technical documentation for: {{feature}} Audience: {{audience}} Product: {{product_name}} Complexity: {{complexity}} Create: 1. **Title**: Clear, action-oriented (e.g., "Setting Up Authentication with OAuth 2.0") 2. **Overview**: 2-3 sentences on what this documentation covers and prerequisites 3. **Quick Start** (for developers): - Minimal working example (copy-paste ready) - Expected output - "If this worked, you're ready for the full guide" 4. **Detailed Guide**: - Step-by-step instructions (numbered) - Code examples with syntax highlighting markers - Configuration options table: | Parameter | Type | Default | Description | - Common patterns and best practices 5. **API Reference** (if applicable): - Endpoint, method, auth requirements - Request parameters table - Response schema with example - Error codes and troubleshooting 6. **Troubleshooting**: | Symptom | Cause | Solution | Cover the 5 most common issues 7. **Related Resources**: Links to relevant docs, tutorials, community forums Writing guidelines: - Use second person ("you") - One action per step - Show expected output after each significant step - Bold UI elements: Click **Settings** → **API Keys** - Include copy buttons on all code blocks - No assumptions about prior knowledge — link to prerequisites
Save this prompt to your library
Organize, version, and access your best prompts across ChatGPT, Claude, and Cursor.
Related prompts
Blog Post Generator
Generate SEO-optimized blog posts with customizable tone, audience, and structure.
Blog Post Outline GeneratorA structured blog post outline generator with SEO considerations, section breakdowns, and linking opportunities.
Long-Form Article WriterA comprehensive article writing prompt with structure, SEO considerations, and quality guidelines.
Email Newsletter WriterEmail newsletter writing prompt with subject line options, structured sections, and engagement elements.