Back to prompts4 Recommendations
The README Reviser
Update documentation for recent changes, framing them as how it always was
Rating
00
Jeffrey Emanuelv1.0.0~300 tokens
Additional Context
Prompt
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
Reviews
No reviews yet
Be the first to share your experience with this prompt.
Related Prompts
You might also find these useful
Intermediate
FeaturedThe De-Slopifier
Remove telltale AI writing patterns from documentation and text
writingdocumentationediting+2
350 tokens
View
Intermediate
CLI Error Tolerance
Make CLI tools forgiving of minor syntax issues for agent ergonomics
cliagent-friendlyerror-handling+1
450 tokens
View
Advanced
The Code Reorganizer
Restructure scattered code files into a sensible, intuitive folder structure
refactoringorganizationstructure+2
800 tokens
View
Advanced
FeaturedDeep Performance Audit
Systematic identification of optimization opportunities with proof requirements
performanceoptimizationprofiling+1
1200 tokens
View