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 Visualization Code Generator
Generate interactive data visualizations with multiple chart types from data descriptions
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.
AI Agent Task Brief Writer
Creates a structured, unambiguous task brief to hand off to an AI coding or desktop agent like Claude Code, Codex, or Manus — minimizing back-and-forth and maximizing first-attempt success.
Chain-of-Thought Reasoning
Step-by-step reasoning prompt for complex problem solving