- 本 README 用于指导如何编写“架构重构执行蓝图”。
- 目标是提供一套与具体业务领域无关、可复用、可验证、可审计的文档框架。
- 建议将每次重构蓝图文档放在本目录,并遵循本模板结构。
- 任何涉及架构演进、模块拆分、依赖治理、运行时治理、质量门禁建设的项目。
- 适用于单体、分层系统、分布式系统、插件化系统等不同形态。
- 以本模板创建新文档,先固定章节骨架。
- 先写“约束与目标”,再写“现状与差距”,最后拆“工作包与验收”。
- 每条需求都必须映射到验收标准、证据路径、验证命令。
- 每次实施后同步更新状态矩阵、执行清单、执行快照。
- 提交前确保文档内命令可执行且结论与代码一致。
- 状态、版本、日期、适用范围、文档定位、最近一次验证结果。
- 说明当前问题、约束前提、不可妥协的决策与边界。
- 仅保留可验收目标,不写口号式描述。
- 明确本次覆盖内容与明确不处理内容。
- 使用“必须/禁止”语义表达,且每条可验证。
- 只写可定位的事实,必须附文件或模块证据。
- 推荐字段:
ID | 需求 | 验收标准 | 当前状态 | 证据 | 差距。
- 对未闭环项进行可执行拆解,区分已完成与待完成部分。
- 描述职责划分、依赖方向、关键链路、运行时边界。
- 每个工作包定义:目标、范围、产物、DoD、优先级、状态。
- 给出阶段目标、时间计划、依赖关系、交付件。
- 保证每条需求均有自动化或半自动化验证路径。
- 定义重构完成的全局闭环标准。
- 风险需可观测,应对需可执行且可复核。
- 与工作包一一对应,直接反映执行进度。
- 输出“已完成/部分完成/阻塞项”,并标注日期。
- 约束文档同步、主链路治理、删除策略、回归验证责任。
- 非业务绑定:避免出现任何具体业务词、业务流程或业务对象命名。
- 非实现绑定:避免把某一技术产品当作模板前提。
- 可追溯:每条判断可回溯到代码、测试、脚本或配置证据。
- 可执行:每条关键要求可映射到命令与通过标准。
- 可持续:状态变更时同步更新矩阵、清单、快照。
- 文档中建议使用占位术语,按项目实际替换:
<CoreModule>:核心模块<RuntimeComponent>:运行时组件<StorageAdapter>:存储适配层<IngressFlow>/<EgressFlow>:输入/输出链路<HostLayer>:宿主装配层
- 命名建议:
<topic>-requirements.md或<topic>-blueprint.md。 - 图示建议:统一使用 Mermaid,并遵循仓库图示规范。
- 若新增架构规则,需同时补充对应门禁脚本和测试。
workflow-run-actorized-state-boundary-blueprint-2026-03-08.md:workflow从“定义 Actor + 模块私有运行态”演进到“definition actor + run actor + 无状态 step executor”的重构蓝图。workflow-run-actorized-target-architecture-2026-03-08.md:workflow重构完成后的目标架构说明,聚焦最终职责边界、状态归属、事件流与读写侧模型。
# <Blueprint Title>
## 1. 文档元信息
## 2. 背景与关键决策(统一认知)
## 3. 重构目标
## 4. 范围与非范围
## 5. 架构硬约束(必须满足)
## 6. 当前基线(代码事实)
## 7. 需求分解与状态矩阵
## 8. 差距详解
## 9. 目标架构
## 10. 重构工作包(WBS)
## 11. 里程碑与依赖
## 12. 验证矩阵(需求 -> 命令 -> 通过标准)
## 13. 完成定义(Final DoD)
## 14. 风险与应对
## 15. 执行清单(可勾选)
## 16. 当前执行快照(YYYY-MM-DD)
## 17. 变更纪律