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
AI Persona Role-Play Generator
Generate immersive role-playing prompts that establish distinct AI personas with specific expertise, tone, and communication styles.
Podcast Show Notes Generator
Generates comprehensive show notes from podcast audio including timestamps, key topics, guest info, and links.
Video Content to Blog Post Repurposer
Converts YouTube video transcripts or summaries into fully structured, SEO-optimized blog posts with headers, quotes, and calls to action.
Weekly AI Digest Newsletter Generator
Transform raw AI news and tool launches into a polished, engaging weekly newsletter digest with summaries, insights, and curated recommendations.