Write documentation for this [project/API/tool/function]:
[paste code or describe what it does]
Audience: [e.g. developers integrating the API, new team members, end users]
Include:
- What it does and why someone would use it (skip if obvious)
- Quickstart: the fastest path to “it works” with a real example
- All parameters/options with types and defaults
- Common pitfalls or things that aren’t obvious from the signature
Write it like you’re saving future-me from a 2am debugging session. No filler paragraphs.