跳到正文
cccskills
免费在 GitHub 公开

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.

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit
查看安装方法

包含的文件（2）

  • SKILL.md4.1 KB
  • references/review-scope.md1.2 KB

SKILL.md（原文）

安装前可以查看交给 AI 代理的指令内容。

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?

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护，适用 Google 的隐私权政策和服务条款。

同一仓库的技能

ai-model-nodejs

免费

Use this skill for Node.js backend AI via @cloudbase/node-sdk (>=3.16.0) — cloud functions, CloudRun, Express/Koa/NestJS, serverless APIs, scheduled jobs, LLM proxies, agent orchestration. The only SDK supporting image generation (ai.createImageModel + generateImage). Text via ai.createModel with groups cloudbase, hunyuan-exp, or custom-*; model ids (e.g. deepseek-v4-flash, glm-5, kimi-k2.6) go in the `model` field of generateText/streamText. MUST run two-step preflight before code — see body. NOT for browser/Web (use ai-model-web) or Mini Program (use ai-model-wechat).

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

ai-model-web

免费

Use this skill when a browser/Web app (React, Vue, Next, Nuxt, static sites, SPAs, dashboards, AI chat UI, 页面, 前端, 网页) needs AI models via @cloudbase/js-sdk. Default routing for Web/frontend AI — call directly from the browser, do NOT propose a Node.js proxy. Covers generateText and streamText; models via ai.createModel with groups cloudbase, hunyuan-exp, or custom-*, model id in the `model` field. MUST run two-step preflight before code — see body. NOT for Node.js backend (use ai-model-nodejs), Mini Program (use ai-model-wechat), or image generation (Node SDK only).

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

ai-model-wechat

免费

Use this skill for WeChat Mini Program AI via wx.cloud.extend.AI (小程序, wx.cloud apps). Covers generateText and streamText with callbacks (onText, onEvent, onFinish); streamText needs a data wrapper, generateText returns the raw response. Models via wx.cloud.extend.AI.createModel with groups hunyuan-exp (小程序成长计划), cloudbase (main managed), or custom-*; model id goes in the data wrapper `model` field. MUST run two-step preflight before code — see body. NOT for browser/Web (use ai-model-web), Node.js backend (use ai-model-nodejs), or image generation (use ai-model-nodejs).

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

api-contract-review

免费

Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata, or related docs for outdated or incorrect action names, parameters, casing, request shapes, or missing contract tests, especially during periodic quality review or before preparing corrective PRs.

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

auth-nodejs-cloudbase

免费

CloudBase Node SDK auth guide for server-side identity, user lookup, and custom login tickets. This skill should be used when Node.js code must read caller identity, inspect end users, or bridge an existing user system into CloudBase; not when configuring providers or building client login UI.

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

auth-tool-cloudbase

免费

CloudBase auth provider configuration and login-readiness guide. This skill should be used when users need to inspect, enable, disable, or configure auth providers, publishable-key prerequisites, login methods, SMS/email sender setup, or other provider-side readiness before implementing a client or backend auth flow.

中文简介正在准备中。当前显示原文说明。

TencentCloudBase/CloudBase-AI-Toolkit11412026年10月20日 更新

查看 TencentCloudBase 的全部技能

报告此技能的问题