接口文档要写在概要设计里吗_概要设计报告怎么写

概要设计主要是针对一个模块做出的可指导详细设计、开发和测试的功能性文档。同时也帮助设计者理清自己的思路。有些时候想象的内容和真正写出来是有区别的，能够将想的内容写出来才能更深刻的理解。

概要设计主要包括总体目标，业务流程，系统接口，子功能设计，数据库建模几个方面。

总体目标：主要介绍该模块的功能划分，例如：个人空间包含个人设置、好友管理、订单管理、账户管理。每个功能再做细分，例如：个人设置包括个人信息维护、密码修改、登录退出、个人地址维护、个人爱好设置。好友管理包括好友列表、好友搜索、添加/删除好友、足迹、好友聊天等。然后将这些功能整理成功能列表或者功能结构图。并针对这些功能给出简单的介绍，例如：个人设置是用于个人信息的维护，个人可通过个人设置功能修改用户信息，密码，地址、兴趣爱好等信息，并明确哪些信息可以修改，哪些不可以修改。

业务流程：描述该模块的具体实现流程，内部处理关系和外部处理关系。例如：内部处理可通过信息采取获取用户数据，个人信息与好友管理、订单管理、账户管理相关联。外部处理是本模块的数据对其他模块的影响，个人信息与产品模块、合同模块、订购模块相关联。所以业务流程需要设计人员对系统有充分的了解。从业务的开始到结束，每一步需要执行什么样的操作，哪一步需要录入，哪一步需要处理，当存在是/否关系的时候，需要按不同的选择来执行，最后形成业务流程图、数据流程图、页面功能流转关系图。

系统接口：描述此模块可以对外提供的接口和需要调用的接口。例如可提供用户信息查询接口，其他模块可通过用户信息查询接口直接查询用户数据。本模块需要调用订单查询接口和合同查询接口，需要订单模块和合同模块提供接口。这里只需要将接口名称列出即可，具体内容可以放到接口文档中详细介绍。

子功能设计：针对模块中的每个子功能做详细说明，主要包括功能定义、性能预期、接口定义，页面元素列表等。例如：个人设置中的个人信息维护功能，主要用于实现用户信息的更新和维护，业务受理相应时间小于3秒，对外提供个人信息查询接口，无需调用外部接口。页面元素，列出不可缺少的内容即可，例如：个人信息维护功能包括账户、昵称、学历、性别、年龄等。

数据库建模：首先使用数据库建模工具，根据系统设计中的数据库规范，对数据库做物理建模，形成物理模型，在文档中只列出本模块所需的表名即可。例如：本模块使用到的数据库表，用户表dv_user，图片表dv_img，文件表dv_file等。

概要设计中的功能点、流程、性能、功能流转、数据库物理模型可为后续的详细设计、开发、测试提供依据，概要设计要经过评审和讲述，所以概要设计报告是后续的开发工作达成共识的基础性文档。现在很多软件开发都省略了概要设计环节，不形成文档，只是将里面的内容单独抽离出来，只需要流程图、功能结构图、数据库表等几种。采用什么方式都是根据实际需要而采取的措施，但是还是建议软件项目要保留一份概要设计，也可作为公司内部的项目文档留存。

接口文档要写在概要设计里吗_概要设计报告怎么写相关推荐

DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
放弃丑陋的 swagger-ui，使用 knife 接口文档生成神器
文章目录接口生成利器 knife 介绍 springboot 整合 knife pom.xml 文件增加依赖编写Swagger2Config配置文件注意事项总结 knife Gitee 地址: ...
使用knife接口文档生成器详细教程
文章目录一.接口生成器 `knife` 介绍二.效果图三.SpringBoot整合knife 3.1 pom.xml的文件依赖 3.2 编写Swagger2Config配置文件 3.3 注意事项 ...
怎么写一份好的接口文档？
编写一份优秀的接口文档会让软件开发中变得更加轻松,更有效率.这可是关键任务,写得好不仅可以帮助开发人员更好地理解和使用 API 接口,还可以提高整个团队的协作效率. 大家可以在线感受一下优秀的接口文档 ...
接口文档包含哪些内容？怎么才能写好接口文档？十年测试老司机来告诉你
目录接口文档结构参数说明示例错误码说明语言基调通俗易懂及时更新与维护总结那么我们该如何写好一份优秀的接口文档呢? 接口文档结构首先我们要知道文档结构是什么样子的.接口文档应该有清晰明 ...
什么是接口文档，如何写接口，有什么规范？
一.什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护. 二.为什么要写 ...
写java接口的文档工具_【java】适合写接口文档的工具，或者文本语法
由于后端与前端使用ajax交互,后端写接口文档变得非常有必要.以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn.git等无法自动合并word ...
写接口文档及生成mock数据
写接口文档及生成mock数据在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
没有required_springboot-使用OpenAPI之后我再也没有写过接口文档
一前言这篇文章主要是带大家入门下如何使用OpenAPI, 笔者在github上找到对应得swagger项目都没找到javase得人门文章,看了下是基于JAX-RS,吐血了: 二什么是 OpenA ...
java如何写安卓接口文档_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...

接口文档要写在概要设计里吗_概要设计报告怎么写

接口文档要写在概要设计里吗_概要设计报告怎么写相关推荐

最新文章

热门文章