Workflow Code Review

Review Documentation Changes

Review workflow for documentation accuracy and completeness

reviewdocumentationquality
CLAUDE.md

When reviewing documentation changes:

  1. Read the documentation as if you’ve never seen the project. Does it make sense?
  2. Verify code examples actually work. Copy-paste and run them if possible.
  3. Check for accuracy: does the documentation match the current code behavior?
  4. Check for completeness: are all parameters documented? Are error cases mentioned?
  5. Check links: do internal and external links resolve correctly?
  6. Check formatting: are headings, code blocks, and lists rendered correctly?
  7. 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.

get crystl