| name | documentation |
| description | 在代码变更落地后更新受影响的文档,确保 docs/ 与代码一致。包含必更新清单、更新原则、文档传感器验证。 |
文档更新
代码变更后的文档同步。只更新受影响的文档,不做无关改进。
协调
直接修改 docs/ 下的文档;在 session README.md(或回报主会话)留变更笔记。完成后运行 node scripts/hooks/dispatcher.cjs stop 验证。
必更新清单
| 文档 | 触发条件 |
|---|
| API 文档 | 接口变更(参数 / 返回值 / 错误码) |
| README | 安装、使用方式变更 |
docs/ARCHITECTURE.md | 架构 / 模块边界 / 组件图变更 |
模块 CLAUDE.md | 模块行为或入口变更 |
按需更新
| 文档 | 触发条件 |
|---|
| 代码注释 | 复杂逻辑、关键算法、设计决策 |
| 配置文档 | 配置项变更(新增 / 默认值 / 移除) |
| 部署文档 | 部署流程或环境要求变更 |
原则
- 只改受影响的文档,不顺手做无关改进
- 文档描述以代码实际行为为准
- 删除已不存在功能的描述
- 沿用现有文档的格式和语气
Red Flags
| 信号 | 行动 |
|---|
| 测试未通过就更新文档 | 先完成测试 phase |
| 文档与代码描述冲突 | 以代码为准修正文档 |
| dispatcher stop 报错 | 先修 [FAIL] 再 ship |
| 想跳过文档更新 | 检查是否真的零受影响文档 |