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.