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 including endpoints, parameters, responses, and examples.
API Documentation Writer (Developer-Friendly)
Generates comprehensive, developer-friendly API documentation from endpoint specs, including descriptions, request/response examples, error codes, and SDK snippets.
Comprehensive Test Strategist
Generate a complete testing strategy including unit, integration, and e2e tests
Code Review Security Auditor
Perform a security-focused code review identifying vulnerabilities