【干货】如何高效编写软件系统设计文档

系统设计文档

前言

作为一名开发人员或架构人员，在实际的开发过程中，在收到需求文档后，会进行对应的系统设计，用来指导开发并可以交付客户。

但是很多同学，对于如何写系统设计文档很头疼，不知道如何来编写。

下面介绍一种思路

在客户项目中，往往客户会规范设计文档的要求，如果有可能，可以要求客户提供该设计文档的模板，基于这个模板来编写，这样可以更好的交付。

如果没有模板，也很简单，可以看公司有没有类似的模板，来规范编写内容。

如果公司也没有，那么只能百度或者谷歌了，找到合适的模板。

对于模板的规范性和重要性，很多开发人员可能认识不足，打个比方模板就类似开发人员的框架，选择正确的框架，可以保证效率和正确。

系统设计文档，其中有以下几个要素必须要注意：

需求背景描述：来源于客户或项目的实际需求理解，这里要描述准确简洁，切记不要直接生搬硬套需求文档或者客户的工作说明书。
总体设计：整体描述系统的架构说明，系统的分层设计和主要流程说明
系统功能设计：按照各个子业务功能模块说明功能，通过流程图、时序图、子模块来说明，按照现在普遍采用的微服务架构来说，可以对应每个微服务。
数据库设计：对应各个业务和模块，设计数据库和表字段的详细说明，含索引和字段描述，如有必要还需要体现分库分表
接口设计：接口包含内部接口和外部接口，内部接口是指内部对接的相关服务，并不对外可见，例如需要对接公司其他业务部门的服务接口，而外部接口则是实际对接客户的接口。接口说明需要说清楚调用方式、地址、出参入参、返回接口、异常说明等。
界面设计：如果有UI界面，需要将前端界面和功能进行说明
维护及SLA说明：系统的运维方式和SLA的情况说明

整理了一套模板，截图如下，目录结构比较清晰

系统设计文档