创建设计文档

Question

在我的组织中，我接到了创建设计文档的任务。

任务描述：

它是一个整体式 Java 模块，我需要将其转换为微服务。这意味着我需要检查此模块中的所有依赖项。如何删除这些依赖项？这需要多少努力。

问题是：我被要求首先为这个从整体到微服务的转换任务创建设计文档。不知道设计文档里面应该放什么？

有人可以帮助我在此任务的设计文档中提及什么吗？

我之前没有创建过任何设计文档。

Answer 1

以下是您可以想到的一些方面：

• 倡议 - 用几句话描述该设计文档所描述的项目的主要思想，以及一些一般准则（例如，我们希望将这个单体系统转换为基于微服务的系统，因为 X、Y和 Z)
• 公开服务的现有架构，以及它对其他模块/组件的所有依赖关系。图表在这里真的很有帮助。
• 暴露系统的期望状态，微服务如何适应新架构（同上，这里需要一张图）
• 分解达到该状态所需采取的步骤。达到最终输出所需的确切更改。您可以明确提及哪些相互依赖，哪些不相互依赖。这样你就知道哪些可以由不同的团队成员执行。您可以将它们放在表格或项目符号列表中）
• 对这些步骤进行一些估计 - 完成这些步骤需要多少天/小时。