reviewing-documentation

To find documentation gaps during code review, compare code diffs against existing project documentation and inline comments. This process identifies missing or stale information by checking if new APIs, changed behaviors, and configuration updates are accurately reflected.

Keeping technical documentation synchronized with the codebase requires systematically comparing code changes against existing docs. By classifying necessary updates into required or recommended categories, you can prioritize technical debt and ensure documentation remains accurate.

Assessing prose quality in technical documentation involves applying specific writing principles to evaluate readability and clarity. This ensures that documentation impacted by code changes remains actionable and clear for users.

You can automate documentation review for git diffs by invoking a systematic analysis skill. It compares the current git diff against existing project documentation and classifies any necessary updates into required or recommended actions.

Documentation-gap analysis works effectively for configuration updates and new APIs. It compares code changes against existing project documentation and inline comments to assess the impact and identify required or recommended documentation updates.

You should classify documentation updates as required versus recommended to prioritize technical debt. This classification framework ensures that critical changes like new APIs or changed behaviors are addressed first, keeping documentation accurate and complete.