doc-freshness-review
Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and `mcp/README.zh-CN.md` during periodic maintenance or before preparing corrective PRs.
npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# Documentation Freshness Review Review whether repository documentation still matches the current code, generated assets, and published entry points. ## When to use this skill Use this skill when you need to: - Audit published documentation under `doc/` for stale or wrong statements - Check whether `README.md`, `README.zh-CN.md`, `mcp/README.md`, or `mcp/README.zh-CN.md` drifted away from current behavior - Verify that linked scripts, files, commands, and workflows still exist and still match the repo - Run a periodic docs health check before opening corrective PRs - Separate mechanical doc drift from product ambiguity that still needs human confirmation **Do NOT use for:** - Marketing copy polish without a freshness or correctness question - API contract review that depends on CloudBase control-plane docs first - Feature planning or architecture design - Rewriting large docs from scratch when the main need is a targeted drift audit ## Workflow ### Phase 1 — Scope the surfaces 1. Read `references/review-scope.md` first. 2. Build the audit surface in two groups: - published documentation under `doc/` - README surfaces such as `README.md`, `README.zh-CN.md`, and `mcp/README.md` 3. N
- When to use this skill
- Workflow
- Phase 1 — Scope the surfaces
- Phase 2 — Evidence-based comparison
- Phase 3 — Severity and action
- Phase 4 — Follow-through
- Routing
- Evaluation prompts
- Should-trigger
- Should-not-trigger
- Minimum self-check
What does the doc-freshness-review skill do?
Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and `mcp/README.zh-CN.md` during periodic maintenance or before preparing corrective PRs.
How do I install it?
Run `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill doc-freshness-review --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From TencentCloudBase/CloudBase-AI-Toolkit, a repository with 1,066 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.