---
name: readme-reviser
description: "Update documentation for recent changes, framing them as how it always was"
version: 1.0.0
author: Jeffrey Emanuel
category: documentation
tags: ["documentation", "readme", "docs", "ultrathink"]
source: https://jeffreysprompts.com/prompts/readme-reviser
x_jfp_generated: true
---
# The README Reviser

Update the README and other documentation to reflect all of the recent changes to the project.

Frame all updates as if they were always present (i.e., don't say "we added X" or "X is now Y" — just describe the current state).

Make sure to add any new commands, options, or features that have been added.

## When to Use

- After completing a feature or significant code change
- When documentation is out of sync with code
- Before releasing a new version
- When onboarding new contributors

## Tips

- Run after every significant feature completion
- Check for removed features that need to be undocumented
- Ensure examples still work with current code

---

*From [JeffreysPrompts.com](https://jeffreysprompts.com/prompts/readme-reviser)*