体系结构--第9章--架构文档的写作.pptVIP

* 9.1 架构编档的使用 9.2 选择相关结构 9.3 结构编档 9.4 跨结构的文档 9.5 统一建模语言 9.6 小结 第 9 章 架构文档的写作 9.1 编写架构文档的目的和原则 1 构架编档的目的与作用 让不同的风险承担者都能快速找到和理解他们所需要的信息。 2 构架文档写作的基本规则是： 就是从读者的角度出发。 9.2 选择相关结构 构架编档的基本顺序是： 将相关结构编成文档，然后向其中添加结构之间关系的文件。 1. 产生一个候选结构列表 先为项目建立一个风险承担者和他们感兴趣的视图表，与项目的具体情况尽可能相符。 2. 组合结构 3. 划分优先级 为了提供一个适当的结构集合，需要根据项目的具体情况确定先做什么，不需要在完成一个结构后再开始另一个结构，可采用宽度优先的方法。 9.3 结构编档 没有对结构进行编档的工业标准模板。 在实践中，文档通常包括下面七部分内容： ? 展示结构中的组件和组件之间关系的主要表示，常用图形方式。 ? 组件目录至少祥述在主要表示中提到的组件和组件之间的相互关系，还包括组件的接口和行为。 ? 系统与其环境相关的上下文图。 ? 可变性指南，包括： 要在其中做出选择的选项 做出选择的时间 ? 解释构架设计的背景，包括： 基本原理 分析结果 设计中所反映的假定 ? 结构中所选择的术语表。 ? 其他信息。 9.3.1 对行为进行编档 结构仅提供了系统的组成信息，并不能据此对某些系统行为进行推断，而行为描述可以提供元素间的交互顺序、并发机会以及交互的时间依赖性的信息。 对行为的描述可以采用不同的建模技术和表示法，这取决于所要进行的分析的类型。 在UML中，顺序图和状态图用于行为描述。 9.3.2 对接口进行编档 接口就是两个独立的实体相遇并进行交互或通信的边界。 组件接口就是其他组件可对该组件所做的假设。 对接口进行编档的模板包括： ? 接口身份 ? 所提供的资源 ? 数据类型定义 ? 异常定义 ? 该接口提供的可变性 ? 接口的质量属性特征 ? 基本原理和设计问题 ? 使用指南 9.5 跨结构的文档 结构文档看起来不应是孤立存在的，而要形成一个整体，这包括构架概述、构架的基本原理和如何安排与组织文档。 构架概述包括： ? 系统概述 ? 结构之间的映射 ? 组件列表 ? 项目词汇 构架基本原理包括： ? 设计决策 ? 预计可能的修改对构架的影响 ? 在实现解决方案中对开发人员的限制 ? 拒绝采用的决策方案 如何组织文档： 构架文档的每个套件都需要有介绍性内容，以向经验不多的涉众介绍其组织结构，并帮助他们获得最感兴趣的信息。文档组织包括两种方式： ? 结构目录 结构的名称和它说明的样式 结构中的组件类型、关系类型和属性的描述 结构目的的描述 结构文档的管理信息 ? 结构模板 9.5 统一建模语言（UML） 具体内容在UML课程中学习。