一键导入
devbooks-docs-consistency
devbooks-docs-consistency:检查并维护项目文档与代码的一致性,支持增量扫描、自定义规则与完备性检查。可在变更包内按需运行或全局检查。旧名称 devbooks-docs-sync 保留为别名并输出弃用提示。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
devbooks-docs-consistency:检查并维护项目文档与代码的一致性,支持增量扫描、自定义规则与完备性检查。可在变更包内按需运行或全局检查。旧名称 devbooks-docs-sync 保留为别名并输出弃用提示。
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
devbooks-brownfield-bootstrap:存量项目初始化:在当前真理目录为空时生成项目画像、术语表、SSOT、基线规格与最小验证锚点,避免"边补 specs 边改行为"。用户说"存量初始化/基线 specs/项目画像/建立 glossary/初始化 SSOT/把老项目接入上下文协议"等时使用。
devbooks-delivery-workflow:完整闭环编排器,在支持子 Agent 的 AI 编程工具中调用,自动编排 Proposal→Design→Spec→Plan→Test→Implement→Review→Archive 全流程。用户说"跑一遍闭环/完整交付/从头到尾跑完/自动化变更流程"等时使用。
devbooks-ssot-maintainer:维护项目 SSOT 的"可寻址索引与派生进度视图"。用于"修改/同步 SSOT(上游或项目内)→ 生成可审计 delta → 同步 requirements.index.yaml →(可选)刷新 requirements.ledger.yaml"。通常由 `/devbooks:delivery` 在 `request_kind=governance` 路由下调用。注意:SSOT 初始化请使用 `brownfield-bootstrap`。
devbooks-knife:把 Epic 级需求切成可拓扑排序的 Slice 队列,并落盘机读 Knife Plan(用于高风险/史诗级变更的 G3 强制闸门)。
devbooks-archiver:归档阶段的唯一入口,负责完整的归档闭环(自动回写→规格合并→文档同步检查→变更包归档移动)。用户说"归档/archive/收尾/闭环/合并到真理"等时使用。
devbooks-coder:以 Coder 角色严格按 tasks.md 实现功能并跑闸门,禁止修改 tests/,以测试/静态检查为唯一完成判据。用户说"按计划实现/修复测试失败/让闸门全绿/实现任务项/不改测试",或在 DevBooks apply 阶段以 coder 执行时使用。
| name | devbooks-docs-consistency |
| description | devbooks-docs-consistency:检查并维护项目文档与代码的一致性,支持增量扫描、自定义规则与完备性检查。可在变更包内按需运行或全局检查。旧名称 devbooks-docs-sync 保留为别名并输出弃用提示。 |
| recommended_experts | ["Technical Writer","System Architect"] |
| allowed-tools | ["Glob","Grep","Read","Edit","Write","Bash"] |
目标:明确本 Skill 的核心产出与使用范围。 输入:用户目标、现有文档、变更包上下文或项目路径。 输出:可执行产物、下一步指引或记录路径。 边界:不替代其他角色职责,不触碰 tests/。 证据:引用产出物路径或执行记录。
适用:需要细化策略、边界或风险提示时补充。
适用:需要与外部系统或可选工具协同时补充。
执行前必须按以下顺序查找配置(找到后停止):
.devbooks/config.yaml(如存在)→ 解析并使用其中的映射dev-playbooks/project.md(如存在)→ Dev-Playbooks 协议,使用默认映射project.md(如存在)→ template 协议,使用默认映射devbooks-docs-syncdevbooks-docs-consistencyscripts/alias.sh 输出提示。弃用提示示例:
devbooks-docs-sync 已弃用,请使用 devbooks-docs-consistency。
docs-consistency 是 DevBooks Apply 阶段的文档一致性检查角色,负责识别文档与代码之间的偏差并生成报告,不直接修改代码。
| 文档类型 | 目标受众 | 是否由本 Skill 检查 | 示例 |
|---|---|---|---|
| 活体文档 | 最终用户 | ✅ | README.md, docs/*.md, API.md |
| 历史文档 | 最终用户 | ⚠️(只做最低限度检查) | CHANGELOG.md |
| 概念性文档 | 设计/架构 | ✅(结构性检查) | architecture/*.md |
分类规则可配置,默认规则见 references/doc-classification.yaml。
触发条件:在变更包上下文中运行。
行为:
触发条件:用户显式请求全局检查(如 devbooks-docs-consistency --global)。
行为:
触发条件:用户使用 --check 参数。
行为:只检查、不修改,输出报告。
# 规则引擎:持续规则
bash scripts/rules-engine.sh --rules references/docs-rules-schema.yaml --input README.md
# 规则引擎:一次性任务
bash scripts/rules-engine.sh --once "remove:@augment" --input README.md
# 文档分类
bash scripts/doc-classifier.sh README.md
# 完备性检查
bash scripts/completeness-checker.sh --input README.md --config references/completeness-dimensions.yaml --output evidence/completeness-report.md
# 作为 G6 Scope Evidence 的机读报告(固定落点)
skills/devbooks-delivery-workflow/scripts/docs-consistency-check.sh <change-id> \
--project-root . --change-root dev-playbooks/changes --truth-root dev-playbooks/specs
对活体文档执行完备性检查,默认覆盖:环境依赖、安全权限、故障排查、配置说明、API 文档。
references/completeness-dimensions.yaml<change-root>/<change-id>/evidence/completeness-report.md风格偏好读取优先级:命令行参数 > 配置文件 > 默认值。
dev-playbooks/specs/_meta/docs-maintenance.md默认输出以下报告(变更包上下文):
evidence/gates/docs-consistency.report.json(机读;供 G6 / archive-decider 消费)evidence/completeness-report.mdevidence/token-usage.logevidence/scan-performance.log在归档阶段由 devbooks-archiver 触发,在存量初始化时由 devbooks-brownfield-bootstrap 生成文档维护元数据。
当 G6 触发 Scope Evidence Bundle 且判定“docs 一致性为必需项”时(例如 deliverables 涉及 README.md/docs/**/templates/**,或存在 weak_link+docs 的 severity=must 义务):
evidence/gates/docs-consistency.report.json 且 status=passstatus!=pass 将被 archive-decider.sh 判定为 fail,从而阻断归档| 字段 | 值 |
|---|---|
| Skill 名称 | devbooks-docs-consistency |
| 阶段 | Apply(实现后、归档前) |
| 产物 | 文档一致性检查报告 |
| 约束 | 只检查、不修改代码 |
此 Skill 文档遵循 devbooks- 规范。*