我是否也应该记录当前的上下文和范围？

Question

我目前正在为一个应用程序编写一个arc42规范文档，该文档应该用来替换几个复杂的手动过程。

在文档以及我注意到的示例中，“上下文和范围”通常只包括要开发的应用程序的上下文和范围。

我还应该包括当前流程的图表吗？就我个人而言，我认为显示应用程序的“前”和“后”状态之间的差异将有助于将其包括在内。

Answer 1

arc42将帮助沟通和记录软件体系结构--因此，支持理解的所有内容都可能包括在内。

“范围和上下文”显示系统及其近邻，包含所有外部接口。我建议使用一个图表加一个表格--就像第42章-第3节中建议的那样。

在arc42中，您通常可以选择在哪里(以及如何)传递信息，因此我们为其创建了一个相当广泛的docs.arc42.org和faq.arc42.org站点。

根据您对工具的选择和现有信息的种类，我看到了几个选项或方面：

1.使用当前的手工过程作为新系统的动力

您提到的“手动处理”可能是创建新系统的强大动力。因此，您可以在第1.2节(导言/动机)中描述这些手动步骤的一些缺点或问题。

2.将第3条(上下文)拆分为“先”和“新”

如果这些“手动过程”与外部接口相关，您可能会创建一个3.1节，描述当前的情况及其缺点)

在3.2中，您可以提出或指定具有改进或自动化流程的新系统。

3.“手动处理”可以显示在"6.运行时视图“下面。

“流程”由一系列步骤或活动组成--因此可以是arc42运行时视图的一部分。

4.将“手册程序”委托给另一类文件

您可以创建一个“审查当前情况”文档，用“手动处理”和相关的问题和风险来描述当前的情况。

在这种情况下，您将避免使用与新系统的设计、构造和实现无关的信息来充实您的arc42体系结构文档。