en un clic
doc-review
// 统一文档评审 — Layer 1 Python 脚本自动检查 + Layer 2 AI 语义审查双审机制。当 PRD / ARCH / UI-SPEC / DEV-PLAN / TEST-REPORT / DEPLOY-SPEC 等业务文档完成需要门禁评审时使用此 skill。审查范围限 docs/ 业务文档:代码审查由 code-review 负责;框架元资产 (.cataforge/) 审查由 framework-review 负责。
// 统一文档评审 — Layer 1 Python 脚本自动检查 + Layer 2 AI 语义审查双审机制。当 PRD / ARCH / UI-SPEC / DEV-PLAN / TEST-REPORT / DEPLOY-SPEC 等业务文档完成需要门禁评审时使用此 skill。审查范围限 docs/ 业务文档:代码审查由 code-review 负责;框架元资产 (.cataforge/) 审查由 framework-review 负责。
代码评审 — 任务粒度评审 (review) 与项目级健康度扫描 (scan) 双入口;代码质量检查、规范合规验证、安全漏洞检测、腐化指标扫描。当任务卡 GREEN 完成 / Sprint 发布前 / 用户要求扫描代码腐化时使用此 skill。审查范围限 src/ 业务代码:文档审查由 doc-review 负责;框架元资产 (.cataforge/) 审查由 framework-review 负责;Sprint 完成度由 sprint-review 负责。
框架元资产审查 — 对 .cataforge/ 下的 agents/skills/hooks/rules + workflow 拓扑做内容质量与一致性审查。与 platform-audit 形成内审/外审对偶;与 code-review/doc-review 服务于业务产物不同,本 skill 专审框架自身配置。当用户提到框架腐化、SKILL.md/AGENT.md 质量、agent 引用孤立、SKILL/MANIFEST 漂移、Workflow 完整性、model_tier 合规时使用。
CataForge 自更新 — 检测已安装包与项目 scaffold 的版本差异,升级包并刷新 scaffold,运行迁移检查验证一致性。支持 pip 和 uv 两种包管理器,保留 runtime.platform、upgrade.state 和 PROJECT-STATE.md 等用户可编辑状态。当用户提到 CataForge 升级、scaffold 过期、framework 版本不一致、更新框架配置时,使用此 skill。
Sprint 完成度审查 — 计划 vs 实际对比、AC 覆盖验证、范围偏移检测 (gold-plating / drift / 缺失)。当一个 Sprint 全部任务卡完成、需要进入下一 Sprint 或发布前的完成度评估时使用此 skill。本 skill 做 Sprint 级聚合:单任务 code-review 由 code-review review 负责,项目级腐化扫描由 code-review scan 负责,文档评审由 doc-review 负责。
任务拆分 — 功能到任务的分解,确保粒度单一可控。
任务依赖分析 — dev-plan 任务表的依赖关系建模、关键路径计算、环检测、Sprint 分组。**仅处理任务依赖**;代码模块依赖图由 code-review scan 的 coupling 维度负责,请勿混淆。
| name | doc-review |
| description | 统一文档评审 — Layer 1 Python 脚本自动检查 + Layer 2 AI 语义审查双审机制。当 PRD / ARCH / UI-SPEC / DEV-PLAN / TEST-REPORT / DEPLOY-SPEC 等业务文档完成需要门禁评审时使用此 skill。审查范围限 docs/ 业务文档:代码审查由 code-review 负责;框架元资产 (.cataforge/) 审查由 framework-review 负责。 |
| argument-hint | <doc_type: prd|arch|dev-plan|ui-spec|test-report|deploy-spec|research-note|changelog> <doc_file> |
| suggested-tools | Read, Glob, Grep, Bash |
| depends | ["doc-nav"] |
| disable-model-invocation | false |
| user-invocable | true |
docs/reviews/doc/REVIEW-{doc_id}-r{N}.md(首行 YAML front matter + 问题列表 + 严重等级 CRITICAL/HIGH/MEDIUM/LOW)分卷检测: 调用前先 glob docs/{doc_type}/ 目录检测是否存在分卷文件,对每个文件分别执行脚本检查。
调用约定(单一入口): Layer 1 一律通过 cataforge skill run <skill-id> -- <args> 触发,由框架解析 SKILL.md 元数据并派发到内置脚本或项目覆写脚本。不得直接 python .cataforge/skills/.../scripts/*.py——该路径为框架内部实现细节,不保证存在。
主卷调用:
cataforge skill run doc-review -- {doc_type} docs/{doc_type}/{doc_file} --docs-dir docs/{doc_type}/
分卷调用:
cataforge skill run doc-review -- {doc_type} docs/{doc_type}/{vol_file} --volume-type {type} --docs-dir docs/{doc_type}/
volume_type 推断规则 (也可从文件头 <!-- volume: ... --> 自动检测):
*-api.md → api*-data.md → data*-modules.md → modules*-s{N}.md → sprint*-f*-f*.md → features*-p*-p*.md → pages*-c*-c*.md → components规则: 所有分卷必须全部通过 Layer 1 才进入 Layer 2。Layer 1 返回码语义按 §Layer 1 调用协议处理。
Layer 2 短路条件 (降低轻量文档的审查开销):
DOC_REVIEW_L2_SKIP_THRESHOLD_LINES、且 doc_type ∈ DOC_REVIEW_L2_SKIP_DOC_TYPES,则跳过 Layer 2 直接判定为 approvedREVIEW-{doc_id}-r{N}.md 报告,并在报告标题下标注 Layer 2 skipped (short-circuit) 及触发条件(行数、doc_type)通过doc-nav按需加载被审文档和上游依赖,按以下维度审查(括号内为对应的 category 枚举值):
维度收敛: 调用方可传 --focus <category[,...]>(值取自 COMMON-RULES §统一问题分类体系),仅审查指定维度。不传时跑全维度。例如:cataforge skill run doc-review -- prd docs/prd/prd-x.md --focus consistency,ambiguity。
ui-spec专项审查维度(仅当doc_type=ui-spec时追加):
报告编号按 COMMON-RULES §报告编号规则,前缀 REVIEW-{doc_id},目录 docs/reviews/doc/。
产出 REVIEW-{doc_id}-r{N}.md,首行必须为 YAML front matter(按 COMMON-RULES §报告 Front Matter 约定),缺失会导致 cataforge docs index 跳过该文件并被 cataforge doctor 计为 orphan。最小模板:
---
id: "review-{doc_id}-r{N}"
doc_type: review
author: reviewer
status: draft # 出 verdict 后改 approved
deps: ["{doc_id}"]
---
front matter 之后按 COMMON-RULES §问题格式 列出问题,§归因分类 / §统一问题分类体系 提供 root_cause / category 枚举。
三态判定按 COMMON-RULES §三态判定逻辑。判定后变更文档状态,并把本审查报告 front matter 的 status 由 draft 改为 approved(无论 verdict 类型)。
权威清单见
cataforge.skill.builtins.doc_review.CHECKS_MANIFEST(framework-review 自动对账,本段与 manifest 不一致即 FAIL)。
通用 (所有文档类型):
专项检查:
DOC_REVIEW_L2_SKIP_* 短路按文档类型 / 行数判定,brief / 微小 lite 文档直接 Layer 1 即可docs/reviews/code/ 或 docs/reviews/framework/ —— 必须写 docs/reviews/doc/(COMMON-RULES §报告编号规则)