架构设计文档模板

• 需求介绍
• 需求分析
• • 5W
  • 多维度分析
  • 1H
  • 业务建模
• 复杂度分析
• 设计文档
• • 总体方案
  • 架构图总览
  • 核心流程
  • 详细设计
• 架构演进规划

• 主要描述需求的背景、目标、范围、要解决的问题、主要矛盾等
• 方案概述
• 本文涉及概念介绍（团队沟通语言）

全方位地描述需求相关的信息

5W 指 Who、When、What、Why、Where。

• Who：需求利益干系人，包括开发者、使用者、购买者、决策者等。
• When：需求使用时间，包括季节、时间、里程碑等。
• What：需求的产出是什么，包括系统、数据、文件、开发库、平台等。
• Where：需求的应用场景，包括国家、地点、环境等，例如测试平台只会在测试环境使用。
• Why：需求需要解决的问题，通常和需求背景相关

性能要求、成本（硬件、人员、时间）

这里的 How 不是设计方案也不是架构方案，而是关键业务流程、业务架构图，如果是复杂的业务系统，这部分也可以独立成“用例文档”

• 分析需求的复杂度，复杂度常见的有高可用、高性能、可扩展
• CAP原则（一致性、可用性、分区容错性）

需要从整体上描述方案的结构，其核心内容就是架构图，以及针对架构图的描述，包括模块或者子系统的职责描述、核心流程

• 系统结构
• 架构图以及架构的描述
• 架构关键设计点（核心矛盾点）

• 交互流程图（流程图）
• 核心抽象模型及模型间关系（UML类图、ER模型）

• 涉及上下游系统（交互图）
• 主要接口（表格）
• 接口流程图（流程图）

• 详细规划（1、2、3步做什么及时间节点）
• 甘特图
• 鱼骨图

参考

• [1] 架构实战：架构设计文档模板
• [2] 架构设计的本质
• [3] 我是怎么画架构图的