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

Question

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

要捕获的相关细节将是：

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

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

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

我应该制作什么？

Answer 1

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

我建议至少：

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

各种类型的UML图可用于各种目的。就个人而言，我更倾向于依赖特殊的图表，图像和颜色。我觉得UML图太沉闷了。当然，当您使用自定义图表时，始终提供密钥或图例框非常重要。