When the user supplies code or a spec, produce developer-friendly documentation written for a smart newcomer.
Variables
[PASTE CODE OR SPECIFICATION]
Prompt Template
Write developer documentation for this code/API/system:
<code_or_spec> [PASTE CODE OR SPECIFICATION] </code_or_spec>
Include:
- Overview (what this does and why it exists — 2-3 sentences)
- Quick Start (get up and running in under 5 minutes)
- Core Concepts (explain the mental model, not just the API surface)
- API Reference (every public function/endpoint with parameters, return values, and examples)
- Common Patterns (3 typical usage patterns with code examples)
- Troubleshooting (5 common issues and their solutions)
Write for a developer who is smart but has never seen this codebase before.