用类图和序列图捕捉领域概念

类图和序列图是一个很好的组合。大部分的复杂性都可以通过使用它们来弄清楚。


1、列出该领域中的主要实体和概念。
这包括对象、进程和角色。 对于每一个主要的实体或概念,写一个简短的段落,解释它的目的和在系统中的作用。

2、创建类图
使用类图来显示这些实体的结构:

  • - 属性
  • - 方法
  • - 关系

3、将序列图用于工作流。
这些图将说明对象在特定场景中如何相互交互。

4、添加代码链接,了解详细信息。
包含代码库相关部分的参考文献或链接,以方便那些想深入了解实施细节的人。

这只是一个切入点;您可以将人们重定向到您的代码,那里有实现细节。

总结
创建上面所有这些东西并不是因为有人让我这么做,而是因为:

  • - 节省我每次决策的时间
  • - 让团队保持一致
  • - 帮助新人入职(不仅仅是开发人员)