(完整word版)软件架构设计文档实用模板.docx

实用文档 项目名称 错误 !未指定书签。 版本 V1.0 文案大全 实用文档 项目名称 版本： V1.0 错误 !未指定书签。 日期： dd/mmm/yy sad 修订历史记录 日期 版本 说明 作者 日 /月 /年 x.x 详细信息 姓名 文案大全 实用文档 目录 1. 简介 5 1.1 目的 5 1.2 范围 5 1.3 定义、首字母缩写词和缩略语 5 1.4 参考资料 5 1.5 概述 5 2. 整体说明 5 2.1 简介 5 2.2 构架表示方式 5 2.3 构架目标和约束 5 3. 用例视图 6 3.1 核心用例 6 3.2 用例实现 6 4. 逻辑视图 6 4.1 逻辑视图 6 4.2 分层 6 4.2.1 应用层 6 4.2.2 业务层 7 4.2.3 中间层 7 4.2.4 系统层 7 4.3 架构模式 7 4.4 设计机制 7 4.5 公用元素及服务 7 5. 进程视图 7 6. 部署视图 7 7. 实施视图 8 7.1 概述 8 7.2 层 8 7.3 部署 8 8. 数据视图 8 9. 大小和性能 8 文案大全 实用文档 10. 质量 8 11. 其它说明 8 12. 附录A 指南 8 13. 附录B 规范 9 14. 附录C 模版 9 15. 附录D 示例 9 文案大全 实用文档 错误 !未指定书签。 简介 软件构架文档的简介应提供整个软件构架文档的概述。它应包括此软件构架文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述 1.1 目的 本文档将从构架方面对系统进行综合概述，其中会使用多种不同的构架视图来描述系统的各个方面。它用于记录并表述已对系统的构架方面作出的重要决策 本节确定此软件构架文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。应确定此文档的特定读者，并指出他们应该如何使用此文档 1.2 范围 简要说明此软件构架文档适用的范围和影响的范围 1.3 定义、首字母缩写词和缩略语 本小节应提供正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。 这些信息可以通 过引用项目词汇表来提供 1.4 参考资料 本小节应完整地列出此软件构架文档中其他部分所引用的所有文档。每个文档应标有标题、报告号（如果适用）、日期和出版单位。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供 1.5 概述 本小节应说明此软件构架文档中其他部分所包含的内容，并解释此软件构架文档的组织方式 整体说明 2.1 简介 在此简单介绍软件架构的整体情况，包括用例视图、逻辑视图、进程视图、实施视图和部署视图的简单介绍。另外，简要介绍各种视图的作用和针对的用户 2.2 构架表示方式 本节说明当前系统所使用的软件构架及其表示方式。还会从用例视图、逻辑视图、进程视图、部署视图和实施视图中列出必需的那些视图，并分别说明这些视图包含哪些类型的模型元素 2.3 构架目标和约束 本节说明对构架具有某种重要影响的软件需求和目标，例如：安全性、保密性、市售产品的使用、可移植 文案大全 实用文档 性、分销和重复使用。还应记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留代码等 用例视图 本节列出用例模型中的一些用例或场景，这些用例或场景应体现最终系统中重要的、核心的功能；或是在构架方面涉及范围很广（使用了许多构架元素）；或强调或阐明了构架的某一具体的细微之处 在此可以直接引用需求中的相关文档，比如 ROSE模型；用例描述等 对于本系统和其它系统的关系，在用例图上可以清楚的看到，因为其它系统在用例图上被表示为主角 根据项目的实际情况，此节可以省略不写 3.1 核心用例 在此引用 ROSE模型中的用例图即可 3.2 用例实现 本节通过几个精选的用例（场景）实现来阐述软件的实际工作方式，并解释不同的设计模型元素如何促成其功能的实现 逻辑视图 4.1 逻辑视图 在此用图形的方式显示此软件架构的分层、子系统、包之间的关系，并且加入必要的文字说明，特别是架构的分层、机制和模式的说明 在此，还需要将和本系统有接口关系的其它系统都表示出来，这样可以清楚的看到本系统和其它系统的接口逻辑视图，并且还需要将在本系统中负责接口的子系统表示出来 4.2 分层 在此说明逻辑分层的每一层和每一层中的包、子系统。对于每个重要的包，都用一个小节来加以说明，其中应包括该包的名称、简要说明以及显示该包中所有重要的类和包的图。 对于该包中的每个重要类，应包括其名称、简要说明，还可选择包括对其部分主要职责、操作和属性的说明 下面预先设置应用层、业务层、中间层和系统层，实际使用中可以根据需要进行修改 4.2.1 应用层 在此说明软件架构子系统的高层组织，是系统面向外部（主角）、面向功能（用例）的子系统。在这一