软件架构设计模板讲解

架构设计说明书

产品发布标识

[填写说明：模板中用方括号括起来并以蓝色斜体显示的文本，用于向作者提供指导，在文档编辑完成后应该将其删除。文档正文应使用常规、黑色、五号字体即系统设置的“正文”样式

文档页眉处的”xxxx系统”和“版本号”仅为示例，请注意更新封页与页眉符合实际情况。此处的版本号指的是产品版本号

封页简要表中的产品名，如无可以不填写。

当某一章/节没有内容时，必须注明N/A，同时标注理由。例如：本章/节内容无需考虑。特别说明：当某章/节内容参见其它文档时，不能注明N/A，而应该写明参见某文档的具体章节。

华为科技（深圳）有限公司版权所有

内部资料注意保密

修订记录：

派发清单：

＊动作类型：批准、审核、通知、归档、参与会议，其它（请说明）

目录

1 简介 (6)

1.1 目的 (6)

1.2 文档范围 (6)

1.3 预期的读者和阅读建议 (6)

1.4 参考文档 (8)

1.4.1 包含文档 (8)

1.4.2 相关文档 (8)

1.5 缩略语和术语 (8)

2 总体设计思路 (9)

2.1 设计方法 (9)

2.2 设计可选方案 (9)

3 系统逻辑结构 (10)

3.1 总体结构 (10)

3.2 子系统定义 (10)

3.2.1 子系统一 (11)

3.2.2 子系统二 (11)

3.3 接口设计 (11)

3.3.1 产品外部接口 (11)

3.3.2 子系统间接口 (11)

3.4 主要数据模型 (11)

4 系统物理结构 (12)

4.1 总体结构 (12)

4.2 组件定义 (12)

4.2.1 组件一 (12)

4.3 组件接口设计 (12)

4.4组件与子系统对应关系 (12)

5 系统部署 (13)

5.1 网络结构图 (13)

5.2 部署模式 (13)

6 关键技术及公用机制 (13)

6.1 关键技术设计 (13)

6.2 公用机制说明 (13)

7 系统重用设计 (13)

7.1 第三方硬件设备说明 (15)

7.2 第三方软件说明 (15)

8 系统非功能特性设计 (15)

8.1 可扩展性 (15)

8.2 可维护性 (15)

8.3 安全 (16)

8.4 容错性 (16)

8.5 可移植性 (16)

8.6 可部署性 (16)

8.7 ... ... . (16)

9 总体约束 (16)

9.1 遵循标准 (16)

9.2 文件约定 (17)

9.3 目录约定 (17)

9.4 对后续设计的约束 (17)

9.5 ...... .. (17)

10 风险 (17)

11 附录 (17)

1 简介

1.1 目的

[描述本架构设计文档的主要目的。

架构文档从构架方面对系统进行综合概述，描述了系统最高层次上的逻辑结构、物理结构以及各种指南。它用于记录并表述已在构架方面对系统作出的重要决定，并对相关子系统的设计起总体上的指导作用。]

1.2 文档范围

[简要说明此文档的范围：它的相关项目以及受到此文档影响的任何其它事物

例如，本文档适用的产品、模块，覆盖的范围等，受这份文档影响的相关产品、模块等，不在该文档覆盖范围内的但可能引起疑义的问题。]

1.3 预期的读者和阅读建议

[说明此文档的阅读对象，简要说明此文档中其它章节包含的内容与文档组织方式，对于不同读者的阅读方式建议。

如：

XXX系统开发过程的各角色：产品角色、系统分析架构角色、项目管理角色、代码角色、测试角色、文档角色

XXX系统的部署角色、培训角色、维护角色；

XXX公司售前技术支持角色

此文档的第2章描述…..

系统体系结构图

例如：

本文档组织方式：

第一章简介，描述文档的目的；

第二章描述总体设计思路，包括设计方法及备选设计方案和方案的选择；

第三章描述系统的逻辑结构。从最高层次上描述系统的逻辑组成；

第四章描述系统的物理结构。从最高层次上描述系统的物理组成；

第五章描述系统的部署情况；

第六章对系统架构中的关键技术及公用设计机制进行描述；

第七章如何重用以往设计产物及现有设计如何对将来重用产生影响进行描述；

第八章对系统中重要的用例或者有技术难度的部分进行功能实现的描述，以方便设计人员在进行设计、开发时进行参考；

第九章对系统依赖的第三方软硬件进行描述；

第十章对系统的非功能特性设计进行描述；产品经理应当关注该部分的描述是否与产品需求中产品的非功能性需求一致；开发人员应当在后续设计过程中对这部分设计进行关注，避免遗漏；测试人员应当根据这部分的描述制定测试案例，验证是否可以达到产品需求的要求。

第十一章描述系统架构设计中的约束条件；

第十二章描述架构设计中识别的风险，产品经理、设计人员、开发人员和测试人员都应当随时关注这些风险，避免风险发生并及时采取规避、减轻措施。

第十三章附录

]

1.4 参考文档

[架构设计的参考文档应当包括但不限于：产品需求说明书等；

同时，文档中说明为引用、参考的文档也应该在这里列出。

参考文档需要按包含、相关的关系分别在下面的小节中列出。]

1.4.1 包含文档

[当本文有包含文档时，需要提供相关的包含文档列表。

包含文档：作为本架构设计的一部分，是不可分割的组成部分，读者阅读本架构设计时必须同时也阅读的文档。如当架构设计非常复杂而有分册时，则分册就属于本文档的包含文档。]

1.4.2 相关文档

[当本文有相关文档时，需要提供相关文档列表。

相关文档：具有关联关系的文档。读者在阅读架构说明书时如果有必要可以参考阅读的文档。]

1.5 缩略语和术语

[适当时，提供与此文档相关的术语及缩略语的定义。]

缩略语/术语全称说明