小型项目的UML图

Question

突然之间，需要适当的正式文档已经成为我们组织中的一件事。我做的很多工作都是对现有系统的增强和补充。通常是快速修复或新方法等。

我只是不确定我应该/可以在小项目中使用什么样的图表。例如，我正在向现有系统中添加一个新功能，该系统验证字段的格式，他们希望为一个验证一个字段的格式的简单正则表达式提供适当的“用图表进行组件设计描述”。在过去，我们只做伪代码，对于这样的项目来说，这就足够了，因为这个系统有点遗留下来，只有很少的原始文档。

Answer 1

您的主要问题似乎是UML图文档系统，而不是项目。为一个项目要求单独的UML文档是完全荒谬的，该项目包括向现有的大型系统中添加少量功能。

和你的管理层谈谈如何解决这一差异。如果他们想要的只是某种“正式文档”，那么建议一个标准化的表格来处理这样的“小变更”项目(包括“系统要改变”、“变更摘要”、“受影响资产”等条目)。如果他们坚持使用UML纯粹是为了实现词的兼容性，那么用例文档(而不是图表)非常类似，可以满足需求。

另外或者，您可能希望考虑这些遗留项目的创建一些高级UML文档.，并在其中集成未来的更改。

Answer 2

听起来，您现有的代码并没有真正的文档化，所以当您修复代码时，您应该记录所有的最终产品，而不仅仅是您的东西。如果您更改了已经文档化的代码，则应该更新文档以确保其仍然准确。

Answer 3

例如，我正在向现有的系统中添加一个新的功能，该系统验证字段的格式，并且他们需要适当的.

您可以尝试用例图。

很难定义什么是小项目，有时您可能会设计一个小组件，但它可以证明该组件将用于其他100个项目，但在这里我的小尝试。

对于像用例、类、活动、序列和状态图这样的小项目图，可以完成任务.

如果您正在使用intellij进行开发，那么包上的ctrl+alt+shift+u将自动生成类图。