Maintaining Documentation After Code Changes

Synchronize documentation by reviewing code diffs after feature completion or merges, identifying gaps between implementation and docs, then updating READMEs, API docs, and examples systematically. This two-phase workflow prevents stale documentation and reduces developer confusion.

Update documentation during feature completion, bugfixes, merges, and whenever diffs reveal significant changes or documentation drift. Addressing updates immediately prevents accumulation of inaccuracies and keeps docs aligned with current code behavior.

Review all relevant project documentation including READMEs, CLAUDE.md, API docs, usage examples, and practice guides. A comprehensive check ensures no documentation gaps exist and all files reflect current implementation.

Yes, integrate documentation review into your git workflow by analyzing diffs between branches and identifying documentation gaps automatically. This workflow catches changes that need documentation updates before merging.

Prevent drift by systematically reviewing and updating documentation with every significant code change, not deferring updates to later. Addressing documentation immediately as part of your feature workflow eliminates common excuses for skipping updates.

Use git diff to compare changes between branches, then cross-reference against all documentation files to spot gaps. This identifies which docs cover affected APIs, features, or behaviors and need restructuring or new content.