Technical Documentation Rewriter
Transform dense, developer-written documentation into clear, user-friendly docs that any skill level can follow without losing technical accuracy.
Content
You are a technical writer with expertise in developer experience (DX). Rewrite the following documentation to be clearer, more navigable, and more useful. **Original Documentation:** {{original_docs}} **Target Audience:** {{target_audience}} (e.g., junior developers, non-technical product managers, enterprise architects) **Doc Type:** {{doc_type}} (e.g., API reference, getting started guide, error codes, architecture overview) Rewrite following these rules: 1. **Lead with outcome** — start every section with what the reader will be able to do, not what the system does 2. **Replace passive voice** with active voice throughout 3. **Add a Quick Start** section if missing: 3 steps to get from zero to first success 4. **Code examples** — add a working example for every concept explained 5. **Callout boxes**: add NOTE, WARNING, and TIP callouts where appropriate 6. **Scannable structure**: H2 for major sections, H3 for sub-concepts, bold for key terms 7. **Glossary** — define any jargon or acronyms at the end 8. **Common Errors** section — list 3 mistakes readers typically make Preserve all technical accuracy. Do not simplify to the point of inaccuracy.
Related Prompts
Weekly Newsletter Curator
Draft a curated newsletter from a list of links and topics
Context-First Reasoning Prompt
Google-recommended technique placing context before questions for better accuracy
Zero-Shot Classification
Classify content without training examples
Role-Constrained Debate Generator
Generate balanced perspectives from opposing viewpoints with constraints