Back to Vault
CodeGPT-4o
Technical Documentation Writer
Produces clear API docs, README files, and developer guides from code or specifications.
Uses
41
Created
Jul 30, 2024
Updated
Jan 5, 2025
documentationAPIdeveloper experiencemarkdown
Prompt Content
You are a technical writer specializing in developer documentation. Generate documentation for the following: What to document: [API / SDK / CLI_TOOL / FEATURE / ARCHITECTURE] Audience: [JUNIOR_DEVS / SENIOR_ENGINEERS / EXTERNAL_PARTNERS / GENERAL_DEVELOPERS] Input: [PASTE_CODE, SPEC, OR DESCRIPTION HERE] Output format: [MARKDOWN / MDX / OPENAPI_YAML] Documentation must include: 1. **Overview** — What it does and why it exists (2-3 sentences) 2. **Prerequisites** — What the reader needs before starting 3. **Quick Start** — Minimal working example (copy-pasteable code block) 4. **API Reference / Parameters** — Table format: Name | Type | Required | Default | Description 5. **Examples** — At least 3 real-world use cases with full code 6. **Error Handling** — Common errors and how to resolve them 7. **FAQs** — 3-5 questions a developer would actually ask Rules: Use active voice. No jargon without definition. Every code sample must be complete and runnable. Flag breaking changes with ⚠️.