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

Should I document the current context and scope too

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

在文档以及我注意到的示例中,"Context and Scope" 通常只包括要开发的应用程序的上下文和范围。

我还应该包括当前流程的图表吗? 我个人认为,显示应用程序 "before" 和 "after" 状态之间的差异将有助于包括在内。

arc42 应帮助交流和记录 软件架构 - 因此支持理解 的所有内容都可能包含在内。

"Scope and Context" 显示系统及其直接 邻居 ,包含所有外部接口。我建议使用图表加 table - 如 documentation of arc42-section-3

在 arc42 中,您通常可以选择在何处(以及如何)传达信息, 因此我们创建了一个相当广泛的 docs.arc42.orgfaq.arc42.org 网站。

根据您选择的工具和现有信息的种类,我看到了一些选项或方面:

1。使用当前的手动流程作为新系统的动力

您提到的 "manual processes" 可能是创建 新系统。因此,您可能会描述这些的一些缺点或问题 1.2 节中的手动步骤 (Introduction/Motivation)。

2。在 "Prior" 和 "New"

中拆分第 3 节(上下文)

如果这些 "manual processes" 与外部接口相关,您可以创建一个 3.1 节来描述当前情况及其缺点)

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

3。 "Manual Processes" 可以显示在“6.运行时视图”下

"process" 由一系列步骤或活动组成 - 因此可以成为 arc42 runtime view.

的一部分

4。将 "Manual Processes" 委托给另一种类型的文档

您可以创建一个 "Review of the current situation" 文档,描述 "manual processes" 的现状以及相关的问题和风险。

在这种情况下,您将避免使用与新系统的设计、构建和实施没有直接关系的信息来膨胀您的 arc42 架构文档。