【系统架构设计师】体系结构文档化

1. 说明

• 1.绝大多数的体系结构都是抽象的，由一些概念上的构建组成。
• 2.层的概念在任何程序设计语言中都不存在。
• 3.要让系统分析员和程序员去实现体系结构，还必须将体系结构进行文档化。
• 4.文档是在系统演化的每一个阶段，系统设计与开发人员的通信媒介，是为验证体系结构设计和提炼或修改这些设计（必要时）所执行预先分析的基础。
• 5.体系结构文档化过程的主要输出结果是两个文档：体系结构规格说明和测试体系结构需求的质量设计说明书。
• 6.生成需求模型构建的精确的形式化的描述，作为用户和开发者之间的一个协约。
• 7.软件体系结构的文档要求与软件开发项目中的其他文档是类似的。
• 8.文档的完整性和质量是软件体系结构成功的关键因素。
• 9.文档要从使用者的角度进行编写，必须分发给所有与系统有关的开发人员，且必须保证开发者手上的文档是最新的。
• 10.p257。

2. 重要性

• 1.体系结构文档化是系统架构设计过程中的关键步骤，它对于确保软件项目的成功具有重要意义。
• 2.通过文档化，可以清晰地表达系统的结构、组件及其相互关系，为后续的开发、测试和维护工作提供有力的支持。
• 3.同时，文档也是系统设计与开发人员之间的通信媒介，有助于各方对系统设计的理解和实施达成一致。

3. 主要内容

• 1.体系结构规格说明：该文档详细描述了系统的体系结构，包括系统的整体结构、组件划分、组件之间的接口和交互方式等。它是后续开发和测试工作的基础，有助于确保系统的正确性和一致性。
• 2.测试体系结构需求的质量设计说明书：该文档针对体系结构的需求进行测试，确保体系结构满足既定的质量标准和要求。它提供了测试的方法、步骤和预期结果，有助于发现和修复体系结构中的潜在问题

4. 编写原则

• 1.清晰性：文档应清晰、准确地表达系统的体系结构，避免模糊和含糊其辞的表述。
• 2.完整性：文档应包含所有必要的细节和信息，确保读者能够全面理解系统的结构和工作原理。
• 3.一致性：文档中的表述和信息应保持一致，避免出现矛盾或不一致的情况。
• 4.易用性：文档应从使用者的角度进行编写，便于读者理解和使用。同时，文档应易于更新和维护，以确保其始终与系统的实际情况保持一致。

5. 实践建议

• 1.采用标准化的模板：使用标准化的模板可以确保文档的格式和结构一致，提高文档的可读性和易用性。
• 2.注重图文并茂：通过图形、表格和图表等方式直观地展示系统的结构和组件关系，有助于读者更好地理解文档内容。
• 3.定期更新和维护：随着系统的演化和发展，体系结构文档也需要不断更新和维护。确保文档始终与系统的实际情况保持一致，以便为后续的开发和维护工作提供有力的支持。

6. 例题

6.1 例题1

• 1.题目

1.体系结构文档化有助于辅助系统分析人员和程序员去实现体系结构。体系结构文档化过程的主要输出包括(A)。
A.体系结构规格说明、测试体系结构需求的质量设计说明书
B.质量属性说明书、体系结构描述
C.体系结构规格说明、软件功能需求说明
D.多视图体系结构模型、体系结构验证说明

• 2.分析

1.体系结构文档化过程的主要输出结果是体系结构规格说明和测试体系结构需求的质量设计说明书这两个文档。
2.软件体系结构的文档要求与软件开发项目中的其他文档是类似的。
3.文档的完整性和质量是软件体系结构成功的关键因素。
4.文档要从使用者的角度进行编写，必须分发给所有与系统有关的开发人员，目必须保证开发者手上的文档是最新的。