Java资源分享网 - 专业的Java学习网站 学Java,上Java资源分享网
文档规范的终极指南:大型项目开发中必备的设计文档标准 PDF 下载
发布于:2024-08-09 10:42:57
(假如点击没反应,多刷新两次就OK!)

文档规范的终极指南:大型项目开发中必备的设计文档标准 PDF 下载 图1

 

 

资料内容:

 

二、需求分析
(一)交互层分析
主要是针对产品原型,也就是前端部分的分析。
作为后端开发,对前端部分的分析有助于我们梳理需求的业务、功能流程,进而方便我们进行实现环节的用例分析和接口分析。
(二)功能需求分析
从产品模块的角度进行分析,梳理会对我们的哪些模块产生影响,判断是一个通用需求还是一个特性需求,判断是一个横向需求还是一个纵向需求,功能的运作流程是怎样
的。
产品进行服务拆分后,会涉及到多少个服务?这些影响之间是彼此独立的,还是相互耦合的?
功能触发以后的业务流程是怎样的的?数据是怎么流转的?
 
(三)数据分析
该功能的实现,是在现有的数据模型基础上开发,还是需要增加新的数据模型?
对原有的数据模型会产生怎样的影响,是否有可能需求进行数据清洗?
(四)兼容性分析
有一些需求可能属于已有功能的改造,那么有必要考虑兼容性方面的内容。
是否对原有实现有侵入,是否可以兼容,如果不能兼容的处理方案是什么样的?
(五)非功能性分析
这个属于一个提前判断,判断是否可能存在性能问题,可能存在调用链路混乱问题,可能存在的痛点和需要技术攻关的点。
 
三、系统现状分析
系统现状分析,主要是针对现有功能改造,以及与现有接口耦合比较紧密的功能开发。
(一)功能模块现状分析
判断要开发的功能属于哪个模块,需要与哪几个模块联动?
模块分类和定位:首先,要对要开发的功能进行分类和定位,明确它属于哪个模块或子系统。
模块依赖关系:确定新功能与其他模块之间的依赖关系和交互方式。识别哪些模块需要与新功能进行联动,以确保功能的完整性和一致性。
接口和数据传递:了解模块间的数据传递方式和接口,以确保数据的正确流转和互操作性。确保接口的参数和返回值能够满足联动模块的需求。
(二)接口开发现状分析
要开发的功能属于新接口开发,还是既有接口的基础上进行改造,对哪些接口有影响?
接口设计决策:确定新功能是否需要引入全新的接口,还是在现有接口的基础上进行改造和扩展。这需要权衡新功能的特殊需求和现有接口的可扩展性。
接口影响分析:分析新功能对现有接口的影响范围。特别关注那些依赖于接口的其他功能,以确保改动不会破坏现有功能的稳定性。
向后兼容性:确保接口改动是向后兼容的,以不影响现有客户端代码。如果需要破坏性的改动,要提前通知相关开发者并制定过渡计划。