From cb99316f6effcfed0f930180ee68d289ef1b44ea Mon Sep 17 00:00:00 2001 From: Garry Tan Date: Mon, 16 Mar 2026 12:19:24 -0500 Subject: [PATCH] =?UTF-8?q?feat:=20/review=20Step=205.6=20=E2=80=94=20docu?= =?UTF-8?q?mentation=20staleness=20check?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Review skill now cross-references code changes against doc files. If a doc describes a feature that changed but the doc wasn't updated, flags it as INFORMATIONAL with a pointer to /document-release. Co-Authored-By: Claude Opus 4.6 (1M context) --- review/SKILL.md | 14 ++++++++++++++ review/SKILL.md.tmpl | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/review/SKILL.md b/review/SKILL.md index 949a0c65..54bc591d 100644 --- a/review/SKILL.md +++ b/review/SKILL.md @@ -198,6 +198,20 @@ If TODOS.md doesn't exist, skip this step silently. --- +## Step 5.6: Documentation staleness check + +Cross-reference the diff against documentation files. For each `.md` file in the repo root (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, etc.): + +1. Check if code changes in the diff affect features, components, or workflows described in that doc file. +2. If the doc file was NOT updated in this branch but the code it describes WAS changed, flag it as an INFORMATIONAL finding: + "Documentation may be stale: [file] describes [feature/component] but code changed in this branch. Consider running `/document-release`." + +This is informational only — never critical. The fix action is `/document-release`. + +If no documentation files exist, skip this step silently. + +--- + ## Important Rules - **Read the FULL diff before commenting.** Do not flag issues already addressed in the diff. diff --git a/review/SKILL.md.tmpl b/review/SKILL.md.tmpl index dadd211a..f13dae4f 100644 --- a/review/SKILL.md.tmpl +++ b/review/SKILL.md.tmpl @@ -124,6 +124,20 @@ If TODOS.md doesn't exist, skip this step silently. --- +## Step 5.6: Documentation staleness check + +Cross-reference the diff against documentation files. For each `.md` file in the repo root (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, etc.): + +1. Check if code changes in the diff affect features, components, or workflows described in that doc file. +2. If the doc file was NOT updated in this branch but the code it describes WAS changed, flag it as an INFORMATIONAL finding: + "Documentation may be stale: [file] describes [feature/component] but code changed in this branch. Consider running `/document-release`." + +This is informational only — never critical. The fix action is `/document-release`. + +If no documentation files exist, skip this step silently. + +--- + ## Important Rules - **Read the FULL diff before commenting.** Do not flag issues already addressed in the diff.