《软件构架实践》阅读笔记05

系统的构架取决于对构架的需求,因此构架的文档也取决于对文档的需求——也就是说,我们希望如何使用该文档。构架文档不仅是说明性的,而且是描述性的,也就是说,对于某些观众来说,它通过对要指定的决策做出限制,来说明哪些内容是真实的。

我们需要对视图进行编档、对行为进行编档、对接口进行编档、对接口进行编档的模板。在对接口进行编档的时候我们需要识别接口身份对接口进行命名(可能还需要提供一个版本号)、提供一些资源(这个是接口文档的核心)、数据类型定义(如果任何接口资源采用了非底层编程语言提供的数据类型,设计是就需要传达该数据类型的定义。如果它是由另一个元素定义的,那么,对该元素文档中的定义进行引用就足够了)、异常定义(异常定义描述了可以由接口上的资源引发的异常 )、该接口提供的可变性、接口的质量属性特征、元素需求、基本原理和设计问题、使用指南。系统概述简要说明了系统的功能,其用户是谁以及任何重要的背景或限制条件。目的是使读者在头脑中对系统及其目的有一个一致的模型。有时,整个系统有一个系统概述,在这种情况下,构架文档的这一部分将指向该系统概述。因为构架的所有视图描述的都是同一个系统,因此,我们可以合理地推断出任意两个视图都有很多相同的内容。帮助文档的读者可以理解视图间的关系能够使他洞察构架是如何作为一个统一的概念整体来发挥作用的。可以通过提供视图间的映射来弄清视图间的关系,这是加深理解和减少混淆的关键所在。元素列表就是出现在任何视图中的所有元素的索引,连同一个指向定义每个元素的位置的指针。项目词汇列出都定义了对系统来说具有特殊含义的术语。

如果谁也不理解构架是什么或者不知道如何使用它,那么,这个架构是没有价值的。在创建构架的过程中,对构架进行编档是最重要的一步,因为对构架进行编档后,设计师就不用再回答许多关于构架的问题,而且,现在和以后的涉众可以通过构架文档来捕获构架。

原文地址:https://www.cnblogs.com/xiaoabu/p/6416793.html