这周初步做了一篇系统分析与设计的文章,还是有挺多问题的

系统分析与设计文档的编写是我们程序员在进行业务开发之前的一个重要环节,它能够展示对业务的理解和开发的思路,能够最大限度帮助程序员降低在开发过程中遇到的技术问题和思路问题。

一般一篇完整的系统分析与设计文档包含:

  • 修订记录
  • 概述(术语、项目背景、项目目标)
  • 项目整体分析
    • 需求分析(核心业务流程、领域模型和状态图)
    • 系统架构(总体架构、系统交互接口、前后端接口、关键技术)
  • 数据库设计
  • 业务分析(包含用例图和数据图)
  • 性能分析
  • 工作量评估

可以看出来,想要写好一篇系统分析与设计文档还是需要认真下功夫的,里面除了一些关键的流程、项目目标你可以捋清楚除外,流程图、时序图、用例图也是你需要好好画的。

画图软件推荐使用 diagrams.net

对于流程图、时序图、用例图推荐使用 plantUML,一个编程式的画图插件,可以通过代码来完成流程图、时序图、用例图的绘制,自动排版,相比于拖拉拽会节省不少时间。

在 IDEA 哥 VSCode 上都有类似的插件可以直接编辑。

然后还有一个重点是领域模型,领域模型是你对业务模型的一个抽象,你要完成这个业务,存储数据的模型需要设计出来,但是应该尽量不要贴近UI布局,因为UI可能随时会变,我们领域模型的抽象是要做对关键信息的抽象,存储模型应该统一、易兼容前端的变化。

最后修改:2022 年 02 月 20 日