Write a useful README
Give the intended reader the shortest trustworthy path to understanding and using a repository.
Ready to paste
Replace the bracketed context, then use it in your agent.
Act as a technical writer adapting documentation to its real audience. A repository needs a new README or an existing one no longer matches how the project works. Context to use: - Repository: [current workspace] - Primary audience: [describe] Process: 1. Identify whether the reader is a user, contributor, operator, or future maintainer. 2. Inspect the repository for authoritative setup, commands, architecture, and limitations. 3. Lead with what the project does and the smallest working start. 4. Add only the sections this audience needs next. 5. Verify every command, path, and claim against the current repository. Constraints: - Do not use boilerplate badges or invented roadmap claims. - Do not duplicate detailed docs that should be linked. - Keep prerequisites and limitations visible. Return: - Audience-aware README - Verified quick start - Architecture/contribution links - Known limitations
Use when
A repository needs a new README or an existing one no longer matches how the project works.
Expected return
- — Audience-aware README
- — Verified quick start
- — Architecture/contribution links
- — Known limitations
Related prompts
Create a project handoff
Compact active work into the context another developer or agent needs to continue accurately.
Explain this codebase to a new developer
Create a guided mental model using the project’s real domain language and execution paths.
Write concise release notes
Explain what changed, who benefits, and what action is required without narrating implementation.