一、修订记录
版本号、变更类型、修改页面、修改内容、修订人、修订时间
修改位置标记颜色
二、项目简介
项目背景:
讲述项目/需求产生原因,以及是如何贴合当前公司业务进行的项目,竞品分析已经做了相关内容。
项目价值:
讲述项目在当前市场中存在的价值,潜移默化的告诉大家产品的可实施性,让大家更好的实现产品。
项目目标:
讲述项目日后的最终发展目标,让大家以最终目标为方向去推动产品进行。
这部分主要是让参会的人对你的项目有更多的了解,知道为什么要做,这样大家在工作中会更有目标,更有方向。这部分讲的时候给大家打打气,加加油,让这个团队充满凝聚力。
三、名词解释
这部分主要是对一些专业名词,缩略语,帮助用户更好的理解需求文档。例如微信中的二维码,小程序,公众号等,做这些之前至少要给大家讲讲这是什么。
四、全局说明
全局交互
针对全局通用的交互、系统规则等相关内容,可以在全局说明中统一说明。避免在文档中反复出现,导致文档臃肿,造成阅读困难。
比如:输入框定义、类型、数字限制等,分页规则,各类型弹窗交互说明等。
全局异常
对全局通用的异常情况做统一的说明。如断网、误操作、数据丢失、加载中等情况,需要描述对应情况下如何处理,也可以写在具体功能需求描述中。
五、用户角色
用户角色
系统中的用户有哪些角色
角色权限
每个角色拥有哪些权限
权限类型分为:菜单权限、功能权限、数据权限
六、图
业务流程图
描述相对复杂的业务流程,包括正向、逆向流程,如下单流程、退款流程
一般是泳道图
页面流程图
描述页面间交互、跳转的逻辑、规则
#### 页面模块功能结构图
七、功能详述
功能清单
说明本次开发要做的模块和功能,并对每个功能进行描述,让开发知道每个功能是干嘛的,更理解这个功能,功能多的时候需要对功能进行优先级排序。
功能具体描述
一般情况下,从五个方面去描述一个功能,每个需求都这样思考,养成良好的功能工作习惯。
-
定义:描述这是个什么,例如:搜索按钮,位置固定不动
-
数据来源:这个信息是从哪里来的,可能来自用户上传,后台上传,用户简介,客户端等。
-
交互:支持哪些交互,例如点击,长按,左滑,右滑,双击
-
边界:这部分主要就是写一些特殊情况,例如无内容,名称过长显示不全,初始值,最大值,最小值,移动范围等。
八、非功能需求说明
安全
性能
兼容性
埋点
运营
持续更新中
参考链接: