<项目名称>

软件体系结构文档

1.                  简介

[软件体系结构文档的简介提供了整个软件体系结构文档的概述。它包括软件体系结构文档的目的、范围、定义、首字母缩写、缩写、引用和概述。]

2.                  体系结构展示

[此节描述用于当前系统的是何种软件体系结构,以及它是如何展示的。它枚举了用例视图逻辑视图进程视图部署视图实施视图这些必要的视图,对于每种视图,它解释了视图所包含的模型元素的类型。]

3.                  体系结构目标和限制条件

[此节描述对于体系结构具有重大影响的软件需求和目标,例如:安全性、隐私性、可现用产品的使用、可移植性、分发和重用。 它还捕获可能适用的特定约束:设计和实施策略、开发工具、团队结构、进度安排、旧代码等等。]

4.                  用例视图

[此节列出用例模型中满足以下条件的用例或场景:它们展示了最终系统的一些重要的核心功能,或者它们在很大的体系结构范围内运用了许多体系结构元素,或者它们强调或说明了某个具体而微妙的体系结构点。]

5.                  逻辑视图

[此节描述设计模型的重要体系结构部分,例如将模型分解成众多子系统和包。对于每个重要的包,又描述将包分解成类和类实用程序。您应简介重要体系结构类,并描述它们的职责,以及少数非常重要的关系、操作和属性。]

5.1               概述

[此子节描述设计模型在程序包层次结构和层上的整体分解。]

5.2               重要体系结构设计包

[对于每个重要的设计包,均单独设立一个子节,子节的内容包括设计包名称、其简要描述以及一个具有设计包中所含所有重要类和包的图。

对于包中的每个重要类,均包含其名称和简要描述,另外,还可以选择包含关于它的一些主要职责、操作和属性的描述。

5.3               用例实现

[此节通过提供几个所选的用例(或场景)实现,来说明软件实际如何工作,并解释各个设计模型元素如何对它们的功能起到作用。]

6.                  进程视图

[此节描述将系统分解成轻量级进程(单个的控制线程)和重量级进程(轻量级进程的组合)。节的组织方式是将进行通信或交互的进程分为多个组。描述进程之间的主要通信方式(例如消息传递、中断和集合)。]

7.                  部署视图

[此节描述用以部署和运行软件的一个或多个物理网络(硬件)配置。它是部署模型的视图。对于每个配置,它至少应指示执行软件的物理节点(计算机、CPU),以及节点之间的互连(总线、LAN、点到点等等)。 还包括进程视图的进程到物理节点上的映射。]

8.                  实施视图

[此节描述实施模型的整体结构,关于实施模型中软件分解为层和子系统的情况,以及任何重要的体系结构组件。]

8.1               概述

[此子节命名和定义了各层及其内容,关于规定包含到给定层情况的规则,以及层与层之间的边界。包括一个显示层与层之间关系的组件图。]

8.2              

[对于每一个层,均包含以其名称命名的一个子节,位于该层中的子系统的枚举,以及一个组件图。]

 

9.                  数据视图(可选)

[关于系统持久数据存储透视图的描述。如果持久数据很少或根本没有,或者设计模型和数据模型之间的转换是不重要的,那么此节是可选的。]

10.             大小和性能

[影响体系结构的软件主要规模属性的描述,以及目标性能约束的描述。]

11.             质量

[关于软件体系结构如何对系统的所有功能(而不是功能性)起作用的描述,这些功能有:可扩展性、可靠性、可移植性等等。如果这些属性具有特殊的重要性(例如关系到安全或隐私),则必须阐明这些属性。]