【问题标题】：Creating Design Document创建设计文档
【发布时间】：2021-03-10 02:27:44
【问题描述】：
在我的组织中，我收到了创建设计文档的任务。
任务说明：
它是一个单体 Java 模块，我需要将其转换为微服务。这意味着我需要检查此模块中的所有依赖项。如何删除这些依赖项？这需要多少努力。
问题是：我被要求首先为这个单体到微服务的转换任务创建设计文档。我不知道我应该在设计文档中放什么？
谁能帮我在这个任务的设计文档中提到什么？
我之前没有创建任何设计文档。
【问题讨论】：
标签：
java
architecture
microservices
【解决方案1】：
以下是您可以想到的一些方面：
- 倡议 - 几个短语，用于描述该设计文档所描述的项目的主要思想，以及一些一般准则（例如，我们希望将这个单体系统转换为基于微服务的系统，因为 X、Y和 Z)
- 公开服务的现有架构，以及它对其他模块/组件的所有依赖项。图表在这里会很有帮助。
- 暴露系统的期望状态，微服务如何适应新架构（同上，这里需要一张图）
- 分解达到该状态所需的步骤。您需要进行的确切更改才能达到最终输出。您可以明确提及哪些相互依赖，哪些不依赖。通过这种方式，您知道哪些可以由不同的团队成员执行。您可以将它们放在表格或项目符号列表中）
- 围绕这些步骤给出一些估计 - 完成这些步骤需要多少天/多少小时。