是否有用于记录程序高级体系结构的标准？

我是一名业余开发人员，到目前为止，我的所有程序都很简单，可以在代码中进行记录。在阅读代码时，很清楚我在做什么和这样做（我的标准测试是6个月后查看代码，并在初读时了解所有内容-我的内存跨度很短）。

我现在面对的是一个程序，该程序超出了我记住这些程序之间各种交互的能力。

• 代码本身
• 数据库中的索引
• 各种模块之间的交互（“工作人员”核心代码和“库”模块）

我当前的文档是一个白板，其中有各种各样的框和箭头，它们指向代码，数据库索引，正在执行的操作，状态更改等。仅供参考，一团糟：

我的问题是，对于更复杂的产品的文档记录，是否存在一套标准的或最佳实践的最佳实践集（命名为这是一组以特定名称分组的实践）。

我应该寻找什么关键字（对“文档软件体系结构标准”的一般尝试以及类似的变体，通常会导致用于工作流或建筑体系结构CAD系统的软件）。

我还希望对高级描述没有通用的最佳实践，并且每个人都可以建立自己的哲学。

每个人都没有一个标准。软件项目可能相差很大（想想：helloworld.py与航天飞机中的代码）。

一种非常常见的方法是使用4 + 1模型。这种方法不会尝试将所有内容塞入单一文档样式，而是将设计分为五个部分：

• 在开发视图
• 该逻辑视图
• 在物理视图
• 的过程视图
• 情境

各种视图从四个不同的角度描述了产品。这些场景是用例所在的地方，并描述了其他视图的交互。

注意：这是一个概念模型，并不与任何特定工具捆绑在一起。

你可以在这里阅读更多：

1. 4 + 1建筑视图模型（Wikipedia）
2. 体系结构蓝图-软件体系结构的“ 4 + 1”视图模型（IEEE论文-pdf）

IMHO UML 并不是用于记录现实世界软件体系结构的工具。类图是有用的，但使用的抽象级别为此目的通常太低。用例图通常过于“高级”，并且缺少某些方面。其他UML图类型也有类似的问题（公平地说，包图，部署图，组件图可以记录某些体系结构方面，但是我个人从未发现它们非常有用）。

如果您正在寻找一种实用，实用的方式来记录高级体系结构，建议您熟悉数据流程图。这些很容易理解，并具有可以扩展到不同抽象级别的优点。我发现它们对于记录不同类型的系统最有用。太糟糕了，他们没有找到使用UML的方法，但是，尽管如此，您仍然可以找到很多用于制作这些图表的工具-甚至包括Dia或DrawIO之类的免费工具。

附带说明一下，为什么在高级文档中需要“数据库中的索引”？我认为它们是您的（关系型）数据模型的实现细节，根据我的经验，是否添加它们是一个性能和优化问题。

统一建模语言（UML）是软件工程领域的通用，开发性建模语言，旨在提供一种可视化系统设计的标准方法。

我认为我们过去做得更好。UML似乎用洗澡水把婴儿扔了出去。通过提供统一建模语言，它消除了体系结构和实现之间的区别。或者，如果它不打算这样做，那似乎是有效的。

我见过一些怪异的UML模型，坦率地说，它们对我没有任何代码无法做的事情，并且做得更好。