《软件架构设计文档》模板：.docVIP

Project Name Software Architecture Document Version 1.0 Revision History Date Version Description Author yyyy-mm-dd x.x details name 目 录 1. 文档简介 4 1.1 文档目的 4 1.2 文档范围 4 1.3 定义、缩写词和缩略语 4 1.4 参考资料 4 2. 架构描述方式 4 2.1 架构视图阅读指南 4 2.2 图表与模型阅读指南 5 3. 架构设计目标 5 3.1 关键功能 5 3.2 关键质量属性 5 3.3 业务需求和约束因素 6 4. 架构设计原则 6 4.1 架构设计原则 6 4.2 备选架构设计方案及被否原因 6 4.3 架构设计对后续工作的限制（详设，部署等） 6 5. 逻辑架构视图 7 5.1 职责划分与职责确定 7 5.2 接口设计与协作机制 8 5.3 重要设计包 10 6. 开发架构视图 11 6.1 Project划分 11 6.2 Project 1 11 6.2.1 Project目录结构指导 12 6.2.2 程序单元组织 12 6.2.3 框架与应用之间的关系（可选） 12 6.3 Project 2…… 13 6.4 Project n…… 13 7. 运行架构视图 13 7.1 控制流组织 13 7.2 控制流的创建、销毁、通信 14 7.3 加锁设计 14 8. 物理架构视图 14 8.1 物理拓扑 14 8.2 软件到硬件的映射 15 8.3 优化部署 16 9. 数据架构视图 16 9.1 持久化机制的选择 17 9.2 持久化存储方案 17 9.3 数据同步与复制策略 17 10. 关键质量属性的设计原理 17  文档简介 [帮助读者对本文档建立基本印象，并为阅读后续内容扫清障碍。] 文档目的 [文档目的，非项目目的。否则造成同一项目多个文档之间的内容重复，不利于文档维护。本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。] 文档范围 [文档的Scope，非项目的Scope。否则造成同一项目多个文档之间的内容重复，不利于文档维护。] 定义、缩写词和缩略语 [集中列举文档中的定义、缩写词和缩略语。] 参考资料 [本项目经审核的计划书、合同、上级批文；本项目的其他已发表文件；本文档引用的文件资料，如软件开发标准。具体而言，应包括参考资料的题目（必须）、编号、版本号（必须）、发表日期、发布方，必要时还可以说明如何使用这些资料。] 架构描述方式 [为了让读者更好地理解《架构文档》，在本节应当说明文档涉及的架构视图，并指明为了描述设计决策用到了哪些图表和模型。] 架构视图阅读指南 [以多视图的方式来组织《架构文档》是大势所趋。推荐的是经过优化的5视图方法，如下图所示。] 图表与模型阅读指南 [] 架构设计目标 [功能、质量、约束，一个都不能少。] 关键功能 [对架构设计至关重要的功能，包括如下4类：核心功能、必做功能、高风险功能、独特功能。所谓独特功能，指这个功能覆盖了上述3类功能没有涉及到的职责。] 关键质量属性 [人之所以痛苦，很多时候是因为追求错误的东西。下图是确定关键质量的5大原则的整体思路图。] 业务需求和约束因素 [创造性地提出约束需求的4大类型，这是一种极为实用的分类方式。特别是业务需求对架构设计而言是一种约束的观点，解决了很多架构师的现实困惑。下图标明了4类约束在“需求层次-需求方面矩阵”中的位置，可以帮助我们理解产生约束需求的根源。] 架构设计原则 [投标时经常讲“架构设计原则”，但到了《架构文档》，这些着眼大局的考虑却“丢了”。推荐的本文档模板，认为应当把它们“找回来”。] 架构设计原则 [着重描述重大的权衡取舍考虑。] 备选架构设计方案及被否原因 [在概念架构一级，对备选架构设计方案进行描述，并阐述它们未被采用的原因。这有利于团队了解当前架构设计方案的来龙去脉，提高团队对当前架构设计方案的认可度。] 架构设计对后续工作的限制（详设，部署等） [架构设计不仅应该包含“指导”，也应该包含重要的“限制”。例如，一份只是说明“性能和可扩展性都重要”的《架构文档》，实际上忽视了“可扩展性和性能之间存在的矛盾关系”。此时，最有效的办法就是在《架构文档》中明确说明“任何提升可扩展性的架构设计和详细设计，都应通过架构团队的评审才能引入，以确保性能目标不受重大影响”。] 逻辑架构视图 [关注点：此架构设计视图的关注点是职责划分。] [注意：逻辑架构视图无疑是最重要的，但同时也应避免“架构 = 模块 + 接口”等以偏概全的认识。] [参考：任何复杂系统的