V0.1.0需求文档格式
修订记录
版本号 | 修订人 | 修订内容 | 修订日期 |
v0.0.1 | XXX | 示例:新增了权限管理、新闻管理模块 (注:每次修改完需在群里艾特项目组成员) | XXXX-XX-XX |
第一章 前言
1.1 项目背景
[项目背景应提供整个项目的概述。如此项目立项时的行业背景、业务痛点、产品目标、总体方向等,以便阅读者可以了解该产品高度概括的目的与期望,形成一种对产品目标的正确导向。]
1.2 名词解释
[名词解释应提供文档中一些专用词汇的定义或解释,目的在于简化文档后续的理解成本。]
(注:下面填写之后需要在‘xxxx名词库’中备份)
序号 | 名称 | 定义/解释 | 备注 |
1 | 区块链 | 是一个共享数据库,存储于其中的数据或信息,具有“不可伪造”“全程留痕”“可以追溯”“公开透明”“集体维护”等特征。 | |
1.3 角色描述
[角色描述应将产品涉及到的使用者划分为不同的角色,命名并给出具体的定义。]
序号 | 角色名称 | 定义 | 备注 |
1 | 系统管理员 | 具有最大权限,用于更好运维平台 | |
2 | 系统审核员 | 针对系统内需要审核的内容进行审核,如新闻审核 |
注:可在此处附带角色权限清单
1.4 参考资料
[编写文档过程中所参考的相关文档,如:项目投标技术方案、法律文献、相关政策等。]
第二章 总体描述
2.1 业务流程图
[此处为正向业务闭环流程,此处写大的业务模块,细节流程在对应功能体现]
注:泳道图等形式都可以,只需体现大的功能点即可
2.2 功能结构图
[此处填写产品功能结构思维导图]
2.3 需求清单
功能模块 | 一级菜单 | 二级菜单 | 功能描述 | 优先级 | 备注 |
首页 | 我有土地 | 发布转让土地信息 | 转让人发布转让土地信息 | P0-P3一共四级别,P0 优先级最高 |
2.4 状态机
2.5 全局说明
1、小位数输入则显示,不输入则不显示。只支持输入数字并且为必填时,输入数值0,则代表未填。
2、默认规则
3、字段限制
含义 | 方式一 | 方式二 | 方式三 |
数值范围 | [3,100) | 3≤数值<100 | 表示数值大于等于3,小于100 |
位数上下限 | 2-10 | 2≤位数≤10 | 表示位数在2位到10位 |
2.6 其他
[此处填写原型图在线链接、rp文档等]
第三章 功能描述
3.1 XXX管理系统
3.1.1 一级菜单
3.1.1.1 详细功能
1、需求场景(需要包含目标用户和场使用景)
- 示例:系统管理员维护角色信息,主要用于角色的增删改查。
2、流程图(颗粒度要细,需列举各种异常场景)
- 暂无
3、业务规则(需要包含路径、原型、字段规范等)
- 路径:后台管理系统>>系统管理>>角色管理
(1)二级描述
①三级描述
3.1.1.2 详细功能2
1、需求场景(需要包含目标用户和场使用景)
- 示例:系统管理员维护角色信息,主要用于角色的增删改查。
2、流程图(颗粒度要细,需列举各种异常场景)
- 暂无
3、业务规则(需要包含路径、原型、字段规范等)
- 路径:后台管理系统>>系统管理>>角色管理
(1)二级描述
①三级描述