文档检查
在部署批次前运行一次。它只关注结构检查(pnpm docs:validate)无法捕获的问题。
使用最强的模型执行。 发现规则的能力和遵循规则的能力是两回事。
读取范围
不读取全部内容。范围过大时干扰文档增多,会降低准确度。
- 使用
pnpm docs:related <路径…>输入本次部署涉及的代码路径,获取路由到的文档。 - 该文档链接的 ADR 及其所在区域的活跃计划。
pnpm docs:validate因验证日期超过 90 天而发出警告的永久文档。docs/findings.md中的未关闭条目。
检查内容
- 文档与代码的双向不一致。 分别检查代码中有但文档中没有的(遗漏)和文档中有但代码中没有的(幻觉)。只检查一侧会漏掉一半。
- ADR 矛盾候选项。 同一区域两个已接受的 ADR 得出相反结论且不存在替代关系的情况。使用
pnpm docs:links <ADR>检查替代链。 - 与代码重复的值表。 文档是否复制了可从代码中读取的值或列表。
- 超过 90 天的搁置计划。 将其作为询问是否关闭或恢复的条目提出。
- 超过 14 天的 Proposed ADR。 决策已延迟。
- 混入指南的经验记录。 “试过但不行”之类的内容应移至
docs/flows/。 docs/operations/current-state.md中过期的行。 检查日期久远的行表示未确认,而非成功。
输出
向 docs/findings.md 添加条目。每个条目有五行。
- 发现 2026-09-04 · docs/policies/xxx.md
主张:(文档声称的内容)
依据:(代码路径或 ADR 编号)
建议:(需要做什么)
范围:(本次部署修复还是推迟)
不进行修复。解决方案由负责该工作的 PR 提供,该 PR 也会删除此条目。
将已读取的永久文档的验证日期更新为今天。仅更新实际与代码对照过的文档。未对照的文档打上今天的日期会给出虚假的最新信号。
预算
预设找到的三个中有一个是误报。LLM 单独进行不一致检测的精确度约为 0.6。若不确定,则在条目中注明。
在报告的第一行写上「未关闭 findings 数量及最旧条目的年龄」。
关于规则的增删
向此列表添加规则必须提供该规则捕获的实际案例。不加无依据的规则。若 12 个月内无同类失败且 pnpm docs:harness-eval 显示无帮助,则删除该规则。