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
Legacy Code Migration Assistant
Analyze and plan migration of legacy code to modern tech stack
Technical Debt Audit & Refactoring Plan
Analyzes a codebase description or code sample to identify technical debt, prioritize refactoring opportunities, and produce an actionable cleanup plan with effort estimates.
Technical Spec to User Story Converter
Converts raw technical specifications or requirements into well-structured Agile user stories with acceptance criteria, edge cases, and story point estimates.
Reasoning Model Debug Prompt (Chain-of-Thought Code Fixer)
Uses chain-of-thought reasoning to systematically diagnose and fix code bugs, explaining each step of the reasoning process before proposing a fix.