跳到主要内容

架构文档重构 Playbook — 模板目录

本目录是 commons/playbooks/architecture-document-rewrite.md 的配套模板。每份模板独立可复制,按工作流 Phase 在不同时机使用。

模板清单

模板用途何时复制复制目标位置
workstream-status.mdstatus.md 模板(续接协议 + 节点表头 + 章节追踪 + 共识索引 + OQ + 收尾协议)Phase 1 工作流初始化governance/workstreams/<workstream-id>/status.md
adr.mdADR 模板(Context / Decision / Rationale / Consequences / Status / Related,≤80 行)Phase 1 / Phase 10 / 任意 ADR 起草时governance/workstreams/<workstream-id>/decisions/ADR-NNN-<slug>.md
chapter-draft.md章节草稿模板(frontmatter + "这一节回答" 首句 + 内容骨架 + "与其他章节的关系"段)Phase 2 每章起草时governance/workstreams/<workstream-id>/drafts/CHAP-NN-<slug>.md
review-task-packet.mdReview 任务包模板(视角任务 + 待 review 文件 + 维度切片 + 输出格式 + 派发模式)Phase 4 / Phase 7 每轮 Review 启动时每个 Reviewer 一份 prompt,临时文件即可(review 结果归档到 governance/workstreams/<workstream-id>/reviews/
merge-script.pyMerge 脚本模板(drafts/ → 主文档 + heading shift + prologue 截取 + §N 替换)Phase 3 / 每次重新 merge 时/tmp/merge-architecture.py(一次性脚本,不入仓)
retrospective.md复盘文档模板(量化产出 + 五范式实战检验 + 与 playbook 差异 + 反馈给 playbook)Phase 11 工作流收尾governance/workstreams/<workstream-id>/<date>-retrospective.md

使用方式

每份模板都是独立可复制的。复制到目标位置后按模板中的占位符(<项目名> / <workstream-id> / <项目-id> 等)替换。

# 示例:起新项目的 status.md
cp commons/playbooks/templates/architecture-document-rewrite/workstream-status.md \
governance/workstreams/<your-workstream-id>/status.md

# 然后编辑替换占位符

与主 Playbook 的关系

主 Playbook(commons/playbooks/architecture-document-rewrite.md)提供:

  • 方法论框架(§2 方法论矩阵 + 决策矩阵)
  • 五条核心范式
  • 11 Phase 启动到收尾流程
  • 项目特化适配指南
  • 边界与诚实声明

本目录提供:

  • 可直接复制使用的具体模板

先读主 Playbook,再用本目录的模板