Review Documentation Changes
Review workflow for documentation accuracy and completeness
CLAUDE.md
When reviewing documentation changes:
- Read the documentation as if you’ve never seen the project. Does it make sense?
- Verify code examples actually work. Copy-paste and run them if possible.
- Check for accuracy: does the documentation match the current code behavior?
- Check for completeness: are all parameters documented? Are error cases mentioned?
- Check links: do internal and external links resolve correctly?
- Check formatting: are headings, code blocks, and lists rendered correctly?
- Check for stale content that should have been updated alongside the code change.
Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.