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
Senior-Level AI Code Review & Refactor Guide
Performs a thorough senior-engineer-level code review with prioritized refactoring recommendations, security checks, and performance improvements.
Red Team Security Tester
Act as a red team attacker to identify vulnerabilities in systems, code, or proposals
Database Migration Plan
Create a comprehensive plan for migrating between databases
Agentic Code Architect
Design autonomous AI agent systems for complex tasks