<项目名> 架构文档重构 — 工作流状态
续接这个工作流
无论是同一会话续接、新会话续接、还是新 Agent 接手,标准动作:
- 读这份文件(status.md)一页就够 — 知道现在在哪、下一步做什么、哪些事已对齐
- 查决策:如果需要知道某个决策为什么这么定,去
decisions/看对应 ADR 文档 - 查章节草稿:如果需要看某章节当前状态,去
drafts/看对应章节文件 - 不要回看对话历史:所有对齐结论应该已经沉淀到本文件或 decisions/,对话只是加工现场
工作流是什么
<一句话:本工作流的目标是什么。例:把项目
本工作流遵循 commons/playbooks/architecture-document-rewrite.md 的 11 Phase 流程 + 5 条核心范式。
最终产物
projects/<project-id>/engineering/architecture.md— 新主文档(约 X 部分 / Y 节)projects/<project-id>/engineering/engineering-packs/m{N}-*.md— task-oriented Agent 消费包(按里程碑切)governance/workstreams/<workstream-id>/decisions/ADR-NNN-*.md— 关键架构决策文档- 旧主架构文档归档到
_archive/projects/<project-id>/<date>-architecture-v1-rewrite/
当前状态
日期:
所在阶段: <Phase N + 简短描述>
已完成:
- <事项>
下一步:
- <事项>
额外材料:
- <如有调研资产 / 评估资产 等>
章节追踪表
按 9 部分(或项目特化的部分数)组织。每章状态:— = 未开始 / D = 已草稿 / R = 已 review / A = 已 accepted。
第一部分 立架
| ID | 节标题 | 状态 | 草稿文件 | 阻塞 / 备注 |
|---|---|---|---|---|
| CHAP-01 | 文档角色与读者 | — | — | |
| CHAP-02 | 上位继承与不变量 | — | — | |
| CHAP-03 | 架构目标与质量取舍 | — | — |
第二部分 业务架构
| ID | 节标题 | 状态 | 草稿文件 | 阻塞 / 备注 |
|---|---|---|---|---|
| CHAP-04 | 业务对象与关系 | — | — | |
| CHAP-05 | 用户价值与认知流转(或项目特定) | — | — | |
| CHAP-06 | 关键业务场景 | — | — |
<...继续按项目章节结构...>
共识索引
已沉淀为独立决策记录的(见 decisions/)
| 编号 | 决策主题 | 文件 | 状态 |
|---|---|---|---|
| ADR-001 | 工程范式: | decisions/ADR-001-*.md | 已确认 |
| ADR-002 | 架构文档结构: | decisions/ADR-002-*.md | 已确认 |
| ADR-003 | 工程实施栈与协作模式: | decisions/ADR-003-*.md | 已确认 |
待写入独立决策记录的候选
| 候选编号 | 主题 | 触发章节 |
|---|---|---|
| ADR-004 | <某关键决策> | CHAP- |
| ADR-005 | <某关键决策> | CHAP- |
共识但不必独立成 ADR 的小约定
- 稳定编号: 章节用 CHAP-NN / 决策用 ADR-NNN / 部分用 PART-N / 评审轮次用 REV-N。引用时必用编号,不说"上次那个 / 之前讨论的"
- 写作纪律(来自 commons/playbooks/architecture-document-rewrite.md §3 范式 5):
- 内容 > 形式:每节存在必须服务于实施者的具体疑问
- 建设型而非防御型:重点说"做什么 / 怎么做"
- 不解释方法论:方法论选择放 ADR
- 抽象 vs 具体:优先用项目实际场景
- 图配三段说明:图表达什么 / 不表达什么 / 怎么读
- 专有名词第一次出现给一句话解释
- 战略不变量(任何章节不得违反 — 项目自填):
- <项目特定的战略不变量 1>
- <项目特定的战略不变量 2>
- <禁入概念清单>
悬而未决的问题(OQ)
记录推进过程中遇到的需要决策但暂时不裁决的问题。
OQ-001 — <问题标题>
<问题描述 + 候选方案 + 待裁决原因>
会话止 / 节点收尾协议
每次工作流节点完成(或会话即将切换)时执行:
- 跑 verify:
npm run verify:kb(如本仓有该脚本)+ 战略保真度自检 - 更新本文件「当前状态」「章节追踪表」
- 更新「更新历史」(HTML 注释中的节点编号 + 时间 + 事件描述)
- 如有决策升档:把对话期形成的约定写入对应 ADR 或本文件「共识索引」
- 如发现新 OQ:登记到「悬而未决的问题」
完成后用户 / 下个 Agent 即可按"续接这个工作流"协议无缝接手。