logo资料库

软件架构设计文档，模板.doc

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

    相关推荐

    资料库

    课程资源

    共收录17145份资料，累计13个分类，关注成员有19位，主要包括：PHP,网络管理,网页制作,Java,.Net,数据库,3G/移动开发,C/C++,游戏开发,嵌入式,讲义,软件测试,专业指导

    热门标签

    PHP 网络管理 网页制作 Java .Net 数据库 3G/移动开发 C/C++ 游戏开发 嵌入式 讲义 软件测试 专业指导

    最新资料