Turn a project description into a clear, useful README.
Why it works: Naming the audience keeps the README from drifting into marketing; leading with what-it-does mirrors how people actually read them.
This is a message template. Fill in the blanks below, then paste it into the chat.
Write a README for the following project.
Project name: [project name]
What it does: [describe what the project does in plain language]
Who it’s for: [intended audience, e.g. “other engineers on my team”, “open source contributors”, “end users”]
Key details to include:
[any setup steps, dependencies, or prerequisites]
[usage examples or commands]
[anything non-obvious about how it works]
The README should be direct and useful, not a marketing document. Lead with what it does, then how to use it, then anything else someone would need to contribute or run it locally.