首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

概要设计报告怎么写

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

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

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

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

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

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

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

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

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190910A04E5200?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券