Documentation Review

Overview

Review documentation as an executable contract for future humans and agents. The main risk is not awkward prose; it is a confident document that causes the next change to be wrong.

Core principle: every factual claim should be traceable to implementation, configuration, tests, current product behaviour, or an official/versioned source.

When to Use

Mandatory reviews:

• When code changes affect documented behaviour
• Before merging documentation updates
• When reviewing pull requests with documentation
• When documentation seems outdated or unclear
• When adding new documentation

Use especially when: