<项目名称>

软件体系结构文档

版本 <1.0>

[注意:以下模板供与 Rational Unified Process 一起使用。包含在方括号中以蓝色斜体(style=InfoBlue)显示的文本是用于向作者提供指导,在发布文档之前应将这些文本删除。在此样式之后输入的段落将自动设置为正常(style=Body Text)。]

 

修订历史记录

日期

版本

描述

作者

<dd/mmm/yy>

<x.x>

<详细信息>

<名称>

       
       
       

目录

1. 简介         
1.1 目的     
1.2 范围     
1.4 引用     
1.5 概述     

2. 体系结构表示

3. 体系结构目标和约束   

 
5.1 概述     

6. 进程视图

7. 部署视图

8.1 概述     
8.2      

9. 数据视图(可选)       

10.大小和性能               

11.质量               


软件体系结构文档

1.                  简介

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

1.1               目的
本文档使用许多不同的体系结构视图来描绘系统的多个方面,对系统进行全面的体系结构概述。其目的是捕获和传达对系统作出的重要体系结构决策。

[此节定义整个项目文档中软件体系结构 文档的目的,并简要描述该文档的结构。应确定本文档的特定读者,指明期望他们以何方式使用本文档。]

1.2               范围

[关于以下方面的简要描述:软件体系结构文档适用于哪些方面;本文档影响哪些方面。]

1.3               定义、首字母缩写和缩写

[此子节应提供所有术语、首字母缩写和缩写的定义,这些术语、首字母缩写和缩写对于正确解释软件体系结构文档是必需的。可以通过引用项目词汇表来提供此信息。]

1.4               引用

[此子节应提供一份在软件体系结构文档中的其它地方引用的所有文档的完整列表。应当用标题、报告号(如果有)、日期和出版组织来标识每份文档。指定引用项的来源。可以通过引用附录或其它文档来提供此信息。]

1.5               概述

[此子节应描述软件体系结构文档的剩余部分包含哪些内容,并解释软件体系结构文档是如何组织的。]

2.                  体系结构表示

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

3.                  体系结构目标和约束

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

4.                  用例视图

[此节列出用例模型中满足以下条件的用例或场景:它们代表了最终系统的一些重要的、核心的功能;或者它们具有很大的体系结构覆盖范围 - 即它们运用了许多体系结构元素;或者它们强调或说明了体系结构的某个特定的、微妙的点。]

5.                  逻辑视图

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

5.1               概述

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

5.2               重要体系结构设计包

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

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

5.3               用例实现

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

6.                  进程视图

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

7.                  部署视图

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

8.                  实施视图

[此节描述实施模型的整体结构,实施模型中从软件到层和子系统的分解,以及任何重要体系结构实施元素。]

8.1               概述

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

8.2              

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

9.                  数据视图(可选)

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

10.             大小和性能

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

11.             质量

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