本表是文档职责与更新触发的唯一注册表;
chbim-doc-workflowskill 的文件地图与本表对齐。docs/ 层一律简体中文(英文对外仅根../README.en.md)。
| 层 | 文件 | 职责 | 更新触发 | 状态 |
|---|---|---|---|---|
| 事实源 | PRD.md | 需求唯一事实源(FR/TC/O/NFR/DoD + 附录 A–D) | 需求/验收变更(冲突以它为准) | 🟢 活 |
| 事实源 | coding-system.md | 缝编码规律(缝体系 · 模数 · 柱网生成 · 间的命名) | 规律定档时(记日期) | 🟢 活 |
| 事实源 | DECISIONS.md + adr/ | 决策索引 + ADR 推理链 | 决策定档/推翻(新 ADR 标 supersede,旧不删) | 🟢 活 |
| 事实源 | drawing-standard.md | 制图条款归纳与修改策略(GB/T 50001-2017) | 图纸实施或条款修订时 | 🟡 稳 |
| 台账 | ../PROGRESS.md | FR/TC 实现状态矩阵(只挂状态不立需求) | 每个实现小步 | 🟢 活 |
| 台账 | plan-v1-roadmap.md | 里程碑 M0–M5 + 决策闸门 G* 台账 | 闸门定档、里程碑收口 | 🟢 活 |
| 台账 | ../CHANGELOG.md | 对外变更日志 | 仅发版时,日常不碰 | 🟢 活 |
| 契约 | contract-v1-api-schema.md | /api + spec/schema 冻结契约 |
契约变更(bump 版本 + 同步 PROGRESS) | 🟢 活 |
| 工作稿 | g2-terminology-fill.md | G2 术语待填表(临时) | 作者填 → 结论并入 coding-system/PRD → 本文件标「✅ 已收编」保留不删 | ⏳ 待填 |
| 参考 | users.md | 用户画像/痛点溯源(优先级证据) | 新观察材料时 | 🟡 骨架 |
| 快照 | codebase/ | 代码库知识 7 文(acquire-codebase-knowledge 生成) | 架构大变后重生成;未重生成前须在头部标失效 | |
| 日志 | journal/ | 工程日志:过程导向、append-only | 每个工作 session 日终当日一节 | 🟢 已规范 |
| 素材 | images/ | 文档图片 | — | — |
同一件事通常 = journal 一段(过程)+ 一个事实源文件落定稿;不在四处复述正文,用纯文本编号互引(G*/O*/FR-/TC-/ADR-/v)。
- journal/ = 过程流水:目标 · 尝试 · 成败/卡点 · 结论与去向(append-only,可含被否方案)
- DECISIONS/adr = 决策结论 + 推理链(为什么选 X)
- plan-v1-roadmap = 闸门/里程碑状态(G6 定档了吗、M1 还差什么)
- CHANGELOG = 对外可见变化(发版粒度,不记过程)
- 文件名
YYYY-MM-DD.md,一天一文件;同天多主题用## 主题分节,单节要点 ≤6 行。 - 内容骨架:目标 → 尝试/决策 → 成败/卡点 → 结论(引 G*/FR/ADR 编号指去路)→ 下一步。
- 结论升格到事实源后,journal 只留一句去向引用;决策正文不抄进 journal。
- 补记:文件头标「【补记】」,只写可由 commits/文档重建的过程与结论,不虚构当日情境。
各文档 H1 下第一行为职责头:> 层:… | 更新触发:… | 注册表:README.md;既有引言(依据/状态 blockquote)保留在其后。快照类(codebase/)另加「生成日期 + 已过时范围」提示。