xxx模块需求文档模板
官网:https://haomo-tech.com
作者:xxx
邮箱:xxx@haomo-studio.com
版本:v0.1
更改历史
* 2017-12-12 胡小根 增加xxx内容,更改xxx内容,删除xxx内容
* 2017-12-01 李静 增加xxx内容,更改xxx内容,删除xxx内容
* 2017-11-01 胡小根 初始化文档
1 模块概述
模块提供xxx功能(一句话描述)
模块运行的平台包括:
- PC Web
- Android
2 用户角色
本模块涉及到的用户角色包括:
- 超级管理员
- 运营人员
- 领导
- 中层
- 员工
3 功能清单
如何描述功能点?应该从软件开发的角度,来描述可操作、可编程、可量化的功能点。阅读的对象为客户和程序员。 描述功能的思维过程是:1. 想明白什么是对象?2. 每个对象的操作,都思考“增、删、改、查”四个操作。产品经理要特别注意:虽然可以根据以下示例发散思维进行思考,但依然要从客户的角度思考问题,将开发的工作量限定在合适的范围内,而不是无限制发散。
以视频会议为例,介绍功能清单的思考过程
对象是:
会议:对象属性包括哪些?时间、与会人员、主题、会议纪要等(增加其他应有的属性)
注:进一步思考,跟会议相关的对象会有哪些?如果现在还不清楚,可以从操作里面来得到思路。需要说明的是:每列出一个对象,都要思考新增对象跟主体对象之间的关系:是一对一的关系,是不是可以融入主体对象?一般情况下非一对一关系,才需要单独列出。
操作是:
增加会议:换成“人话”,是发起/安排会议。是即时发起,还是预约会议?预约的话,到时间了系统如何处理?
删除会议:换成“人话”,是退出会议。但是:历史会议是不是允许删除?这种情况需要思考。正在开会的会议允不允许删除,也需要考虑?
修改会议:什么是修改会议呢?换成“人话”怎么说?会议前怎么修改?会议中怎么修改?会议后怎么修改?会议前可以修改的是会议的安排,可以修改会议的时间、与会人员;会议中可以修改,也就是每个人可以做的操作:临时增加成员、中途退出、静音等;会议后可以修改的,是不是可以添加会议纪要?
查询会议:查看会议列表和会议详情。会议列表默认有哪些列存在更好?会议详情要包含什么?这里都需要具体进行描述
注意事项:
- 功能编号一旦确定,则不能更改编号对应的内容。如果功能内容描述不准确,在功能描述中做补充说明。
请客户注意:凡是以下功能点未涉及到的操作,均将不再软件中体现。软件中实现的功能点,以下表中的为准
功能编号 | 功能描述 | 基线版本号 |
---|---|---|
video-1 | 增加会议:安排/发起音频/视频会议 | 1.0.0 |
video-2 | 删除会议:只允许删除未开的会议,凡是已开的会议均不允许删除 | 1.0.0 |
video-3 | 修改会议:会议前允许修改xxx;会议中允许修改xxx;会议后允许修改xxx | 1.0.0 |
video-4 | 查询会议:会议列表包含xxx列,会议详情要展示xxx | 1.0.0 |
特别说明无法实现的点:(请产品经理注意:只有特别特殊的情况,才会提无法实现的点。为的是放置客户和程序员在某些特殊场景想偏离)
- 不支持音视频会议切换
- 不支持公网环境音视频会议
4 平台功能矩阵
功能编号 | PC-Web | Android |
---|---|---|
video-1 | 支持 | 支持 |
video-2 | 支持 | |
video-3 | 支持 | |
video-4 | 支持 | 支持 |
5 角色功能矩阵
功能编号 | 超级管理员 | 员工 |
---|---|---|
video-1 | 支持 | 支持 |
video-2 | 支持 | 支持 |
video-3 | 支持 | 支持 |
video-4 | 支持 | 支持 |
6 模块导图
7 关键业务流程
请使用OmniGraffle(Mac用户)或者MS Project(Windows用户)绘制流程图
7.1 xxx流程
流程图说明的编写,需要考虑到“点”和“线”。所有的流程里的节点和节点之间的线,均需要仔细描述
流程图说明如下:
- xxx节点,用户需要做xxx操作
- 从xxx节点流转到xxx节点,触发条件是xxx
8 需求评估
8.1 清晰度评估
说明:
- 评估人通常应该为:项目经理/架构师、产品经理、模块负责人、模块执行人
- 开发前必须要做需求点的评估工作
- 分值从1-10,分值越高,则表明需求越清晰
功能编号 | 项目经理:评估人1 | 产品经理:评估人2 |
---|---|---|
video-1 | 1 | 3 |
video-2 | 5 | 10 |
video-3 | 2 | 2 |
video-4 | 2 | 2 |
8.2 时间评估
说明:
- 评估人通常应该为:项目经理/架构师、模块负责人、模块执行人
- 单位为:人天
功能编号 | 架构师:评估人1 | 模块负责人:评估人2 |
---|---|---|
video-1 | 10 | 30 |
video-2 | 50 | 100 |
video-3 | 20 | 20 |
video-3 | 20 | 20 |
8.3 技术难度评估
说明:
- 评估人通常应该为:项目经理/架构师、模块负责人、模块执行人
- 技术难度从1-10,10为最难,1为最简单
功能编号 | 架构师:评估人1 | 模块负责人:评估人2 |
---|---|---|
video-1 | 7 | 3 |
video-2 | 5 | 10 |
video-3 | 2 | 2 |
video-3 | 2 | 2 |