Skip to content
FunCoding

Search

Search docs, Skills and MCP

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.

数据库与数据1.1kskills/doc-freshness-review/SKILL.md

Install

Send this to Claude Code, Codex or Cursor. The agent checks the Skill for safety first and installs it only after you confirm.

读取 https://funcoding.ai/skills/tencentcloudbase/cloudbase-ai-toolkit/doc-freshness-review/install.md ，按里面的步骤帮我安装这个 Skill。

SKILL.md

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. Note which code, scripts, generated files, or workflows those docs claim to describe.

Phase 2 — Evidence-based comparison

  1. Verify whether referenced files, scripts, commands, and workflow names still exist.
  2. Compare the docs against the current implementation, generated outputs, and source-of-truth files.
  3. Mark each mismatch as one of:
    • stale statement
    • missing or stale reference
    • outdated command
    • drift between published docs and README surfaces
    • drift between docs and actual implementation

Phase 3 — Severity and action

  1. Prefer concrete findings with exact file paths and the smallest useful rewrite direction.
  2. If the fix is mechanical and low-risk, prepare the doc updates for a focused PR.
  3. If the docs may be wrong because product behavior is unclear, write a report and issue instead of guessing.
  4. If the drift originates from a CloudBase API contract problem, hand off to api-contract-review before updating the prose.

Phase 4 — Follow-through

  1. Keep report sections separate for:
    • published documentation
    • README surfaces
    • broken or missing references
  2. Prefer one focused PR per coherent doc drift batch.
  3. Route open-PR repair work to pr-review-fix after the doc finding is confirmed.

Routing

TaskRead
Review docs and README freshness scopereferences/review-scope.md
Review CloudBase API contract drift before changing related proseapi-contract-review
Fix an already-open PR after confirming the doc driftpr-review-fix

Evaluation prompts

Should-trigger

  1. Audit doc/ and the main README files for stale commands, missing files, and broken references.
  2. Review whether mcp/README.md still matches the current MCP tool behavior and linked files.
  3. Help me prepare a corrective PR for docs that still reference scripts or workflows that no longer exist.

Should-not-trigger

  1. Review this TypeScript module for runtime validation gaps.
  2. Compare CloudBase action parameters against the official control-plane docs.
  3. Write a brand-new tutorial for a feature that does not exist yet.

Minimum self-check

  • Did I separately review published documentation and README surfaces?
  • Can I point to exact file paths for every stale or broken reference?
  • Did I compare the docs against current code, scripts, and generated outputs instead of relying on memory?
  • If I recommend a fix, is it a small, reviewable doc batch suitable for a PR?
  • If the underlying product behavior was unclear, did I stop at report or issue instead of rewriting confidently?

Similar Skills

xlsx
anthropics/skills180k

xlsx

Use this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.

Databases & data

deprecation-and-migration
addyosmani/agent-skills103k

deprecation-and-migration

Manages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code.

Databases & data

host-observer
thedotmack/claude-mem98k

host-observer

Use this when fulfilling claude-mem observer jobs on Grok Bot: reply only skip_summary or one full observation XML, never prose.

Databases & data

babysit
thedotmack/claude-mem98k

babysit

Watch a pull request or review cycle until it is ready to merge. Use when asked to babysit, monitor, or keep checking PR comments, reviews, and CI until all actionable issues are resolved.

Databases & data

mem-search
thedotmack/claude-mem98k

mem-search

Search claude-mem's persistent cross-session memory database. Use when user asks "did we already solve this?", "how did we do X last time?", or needs work from previous sessions.

Databases & data

Agent Cost Report
thedotmack/claude-mem98k

Agent Cost Report

Believable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json.

Databases & data