Arc42 Overivewarc42 是用于架构沟通和文档的模板。 arc42 以务实的方式回答以下两个问题，并可根据您的特定需求进行定制： 关于您的架构，您应该记录/沟通哪些内容？ 您应该如何进行文档/沟通？ 1. 介绍与目标对需求、驱动因素的简要描述，提取（或摘要）需求。架构的三个（最多五个）最重要的质量目标，对主要利益相关方具有最高优先级。重要利益相关方的期望表，包括其对架构的期望。 2. 约束限制团队在设计和实施决策方面或相关流程决策方面 ...

arc42 提供了一种明确、简单、有效的结构，用于记录和传达您的软件系统。 将 arc42 的部分比作文件柜的抽屉。arc42 包括12个这样的抽屉，每个抽屉专门用于保存系统架构的特定信息。 arc42 经过优化，以提高可理解性和适当性。它自然地指导您以易于理解的方式解释任何类型的架构信息或决策。 arc42 支持您的工作风格、领域和技术。您可以将其应用于敏捷、精益或正式项目-由您决定。 文档 为什么选择arc42？：arc42 解决了哪些问题？ 一分钟概述：在单页上展示 ...

提示1-6：使用活动图来描述功能要求！ #requirement #activity-diagram #functional-requirement 活动图可以为您做两件事：对活动进行良好的视觉概述，并解释特殊情况、替代方案、并行性或序列的处理。潜在的缺点是创建和维护成本相对较高。 ...

提示10-8：使用（质量）场景进行架构分析或评估！ #requirement #quality #assumption #essential 使用质量场景系统地分析或评估您的架构，ATAM方法。 像下面的表格（类似于提示4-2（解决方案方法作为表格）中提议的结构）可以支持定性评估。 质量目标 场景 解决方案方法 风险 Q-目标1 文本 文本 风险-1 Q-goal 2 文本 文本 风险-2 ...

提示1-9：使用活动图来描述功能要求！ #requirement #plantUML #activity-diagram #functional-requirement 用半正式符号记录一些重要的功能、过程或特征可能是有用的。 以开源PlantUML（https://plantuml.com/）为例。给定以下活动描述，它可以创建一个图形版本： 12345678910111213141516@startumlstart :authenticate; :select ...

提示1-13：如果您没有获得质量要求，请做出明确的假设！ #requirement #quality #assumption #essential 我们一次又一次地体验到，开发团队缺乏来自客户或关键利益相关者的明确质量要求。 这使得质量目标隐含在一起，导致所有相关人员误解和不满的高风险。 Our advice: Make explicit assumptions about appropriate quality goals, based on your knowle ...

提示11-3：通过定性评估识别问题或风险！ #risk #technical-debt #problem #atam 可以通过系统地比较（质量）要求与架构和实施方法来识别一些问题和风险。 另见提示10-8（使用质量场景进行评估）。 ...

提示5-1：在构建块视图的部分使用常见结构！ #building-block #blackbox #whitebox 待办事项：插入黑/白盒特定提示的链接 无论您当前正在记录或指定的详细程度或抽象级别如何：使用统一： 白盒表示（以图形方式）解释结构和内部工作 解释单个构建块的责任和接口的黑盒表示 白盒描述 每个白盒通常通过图表和一些文本解释来解释“高级黑盒”的内部结构和内部界面。 您可以使用UML或任何框/箭头类型的图表。 黑盒描述 黑盒描述： ...

提示5-5：描述每个（重要）黑盒的责任或目的！ #building-block #blackbox #essential 除了一个富有表现力或有意义的名称外，对其责任的简要描述属于构建块视图的真正重要方面。 如果名称以某种方式引用了相应黑盒满足的要求，它们可能会变得非常清晰。描述黑框做或执行什么，避免描述“如何”。特别是在构建块层次结构的较低级别中，单个黑箱履行了一些更高级别的构建块的部分责任。保持这种描述简洁紧凑，最多一两句话。此类描述中有太多的“和”可能是抽象缺失的标 ...

提示5-6：隐藏黑盒的内部工作原理！ #building-block #blackbox #lean #essential 黑盒尊重信息隐藏原则：要使用黑盒，你只需要知道它的责任及其输入和输出接口。其内部运作的其他细节（通常）不需要。 这种隐藏提供了许多优势： 您可以更改或修改内部工作，而无需用户（客户、消费者）适应这些变化。 您可以避免记录此构建块的白盒。这可以减少文档的维护工作。 最终，您降低了一些利益相关者必须考虑或了解的细节水平。 在极端情况下，您将构建块视 ...