doc-freshness-review

1# Documentation Freshness Review
2 
3Review whether repository documentation still matches the current code, generated assets, and published entry points.
4 
5## When to use this skill
6 
7Use this skill when you need to:
8 
9- Audit published documentation under `doc/` for stale or wrong statements
10- Check whether `README.md`, `README.zh-CN.md`, `mcp/README.md`, or `mcp/README.zh-CN.md` drifted away from current behavior
11- Verify that linked scripts, files, commands, and workflows still exist and still match the repo
12- Run a periodic docs health check before opening corrective PRs
13- Separate mechanical doc drift from product ambiguity that still needs human confirmation
14 
15**Do NOT use for:**
16 
17- Marketing copy polish without a freshness or correctness question
18- API contract review that depends on CloudBase control-plane docs first
19- Feature planning or architecture design
20- Rewriting large docs from scratch when the main need is a targeted drift audit
21 
22## Workflow
23 
24### Phase 1 — Scope the surfaces
25 
261. Read `references/review-scope.md` first.
272. Build the audit surface in two groups:
28   - published documentation under `doc/`
29   - README surfaces such as `README.md`, `README.zh-CN.md`, and `mcp/README.md`
303. Note which code, scripts, generated files, or workflows those docs claim to describe.
31 
32### Phase 2 — Evidence-based comparison
33 
341. Verify whether referenced files, scripts, commands, and workflow names still exist.
35…