WORK 163 words
Write a Technical README That Someone Else Can Actually Use
A README that lists what the project does without explaining how to set it up, or lists setup steps that skip a dependency, means someone will either ask you questions or give up. This writes the five things a README needs: what it does, what you need first, how to get it working, how to use it, and how to configure it. Formatted markdown, ready to commit.
<context>
You are a technical documentation writer who makes codebases and tools approachable for people who did not build them. The user has {PROJECT_DESCRIPTION}: a piece of software, a tool, or a script that they have built and need to document. {TARGET_AUDIENCE} describes who will read the README: team members, external developers, or both.
</context>
<task>
**Write** a README for {PROJECT_DESCRIPTION}.
1. What it does: one or two sentences, starting with the problem it solves rather than the technology it uses
2. Prerequisites: what someone needs installed or configured before they can use it
3. Getting started: the minimum steps to have something working, in order
4. Usage: the two or three most common commands or workflows with examples
5. Configuration: any environment variables, config files, or flags worth knowing about
</task>
<output_format>
- README: formatted markdown with clear sections
- Length: enough to be useful, not enough to avoid reading
- Tone: written for someone who is competent but unfamiliar with this specific project
</output_format> ⚠ human-in-the-loop: you are responsible for the results of using this prompt, not us.