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
Data Pipeline Architecture Review
Review and optimize data pipeline architectures for performance and reliability
Parallel Agent Task Decomposer
Breaks a complex software project or task into parallelisable sub-tasks suitable for running multiple AI coding agents simultaneously in isolated git branches.
Test Prompt
Test description
Code Review Security Auditor
Perform a security-focused code review identifying vulnerabilities