Paste code and get documentation people actually read — README, usage examples, and the "gotchas" section every project forgets.
Write documentation for my code that a stressed developer at 6pm actually finds useful. Audience:
{FUTURE ME / MY TEAM / OPEN-SOURCE USERS}.
Produce:
1. ONE-PARAGRAPH OVERVIEW: what this does and when you'd reach for it — written before any
installation details, because people first decide IF they care.
2. QUICKSTART: the minimum copy-paste path from zero to seeing it work. Every command runnable, every placeholder obvious. If setup has a prerequisite, say it BEFORE the step that fails without it.
3. USAGE EXAMPLES: 3 realistic scenarios (basic, typical, advanced) with actual code — examples teach better than API tables.
4. THE GOTCHAS SECTION (the part everyone forgets to write): surprising behaviors, common
mistakes, error messages users will see and what they actually mean, performance cliffs.
5. API REFERENCE: only for the public surface — parameters, returns, throws. Skip internals.
Rules: no marketing adjectives ("blazingly fast", "simple"), present tense, second person ("you"), and every claim testable.
CODE / PROJECT:
{PASTE}