我应该使用什么图表方法来记录现有系统？

Question

我被要求参与一个复杂的现有系统（自然没有现有文档）的文档。

要捕获的相关细节将是：

• 主机名、IP 地址和网络
• 集群的组成
• 软件包名称
• 配置文件的路径
• 一些关键配置值
• 不同主机和这些主机上的服务之间的交互顺序
• 不同组件之间传递的信息
• 系统和子系统的所有权

我想使用一种标准化的方法，或者至少是一些最佳实践，所以我正在考虑使用诸如 UML 部署图和组件图之类的东西，但我是 UML 新手，所以我不确定哪个是最好的。我真的很想使用一种可以捕获所有内容的图表，但如果不是，则尽可能少。

我猜一些相关信息可能不适合图表，在这种情况下我想知道哪种类型的文档会包含详细信息。

我应该生产什么？

Answer 1

如果您在同一张图表中塞入太多关注点，您将会使读者感到困惑。更好的方法是使用多个图表（加上相关的文本和表格）。

我建议至少：

• 描述组件在运行时如何相互交互的视图，以及连接它们的接口的描述。这最好与每个组件的职责描述相关联。
• 描述组件部署方式的视图。
• 描述如何构建各种模块的视图。

各种类型的 UML 图可用于各种目的。就个人而言，我倾向于更多地依赖带有图像和颜色的临时图表。我觉得 UML 图太枯燥了。当然，当您使用自定义图表时，务必始终提供键或图例框。