Technical Documentation Writer
Transform code or APIs into clear, developer-friendly documentation
Content
Write comprehensive technical documentation for {{subject}}. Documentation type: {{doc_type}} Audience technical level: {{audience_level}} Include: 1. Overview and purpose 2. Quick start guide (get running in <5 minutes) 3. Core concepts explained with analogies 4. Complete API/function reference with examples 5. Common patterns and best practices 6. Troubleshooting section with common errors 7. Migration guide (if applicable) Code examples in: {{language}} Tone: Clear, concise, developer-friendly. No jargon without explanation.
Related Prompts
API Documentation Generator
Generate comprehensive API documentation from code or specifications
Security Threat Model Generator
Generates a structured security threat model for an application or system using the STRIDE framework, identifying attack surfaces, threats, and mitigations.
Excel VBA Automation Script
Generate VBA macros to automate Excel tasks
Edge Case Explorer
Generate comprehensive edge cases and boundary condition tests for any system