作者:小步 篇幅:全文约 6000字 阅读时长:约10分钟 提示:以下内容仅为个人分享,有兴趣交流的伙伴可在下方讨论区留言。

知识库首页

产品API:进阶全栈PM手册

提示:上方链接属于全手册首页,伙伴们打开后可以关注或收藏,用于日常工作查看,其中关注后,可以实时收到文档更新通知,希望对你有所帮助。

😅当前文档处于创作中,内容随时出现变更,会存在FLASH记录的草稿,关注后可收到更新通知

产品工作中,产品需求文档(PRD)是作为产品工作者的核心输出内容,主要服务于开发、测试、UI/UX等各端项目成员,是确保产品能够高效正确的开发的核心媒介。

而随着互联网的陆续成熟发展,互联网产品针对需求侧的文档描述结构,也开始有了较通用的模块分布状态,比如不管是后台系统(WEB),还是移动端系统(APP),大多包含了表单、列表、工作流、统计等需求分布。因此,一些通用化的需求描述模板,可以帮助产品工作者高效的完成内容编写,同时经过总结整理的文案描述模块,可以提高内容的条理性和易读性,降低各端对产品需求的理解,达到减少不必要的开发成本的目的

本文主要聚焦于笔者历史工作经验不断积累的文档撰写方法,旨在通过整理总结,将产品需求文档中高频出现的内容模块,做模板化的总结,便于日常工作中可以快速复用描述逻辑,提高文档描写质量,目前内容也在不断积累中,以下内容仅做为个人总结参考,如有不足,敬请反馈。

后台系统类

1-全局框架

权限说明
交互说明

2.列表页面

2.1 标准列表

说明:常规列表页一般包含:入口说明、列表字段说明、内容搜索说明、列表内容操作说明、列表分页说明、权限说明

入口:【一级导航】-【二级导航】
前置条件:具备该二级导航的访问权限

原型 需求说明
示例页面
image.png
Case1 列表展示
入口:
位于【XXX导航】-【三级菜单】
前置条件:
需要具备什么权限可访问此页面
默认加载的数据及范围,无数据,则展示缺省页面

内容说明:
1、列表字段说明:
日期类型:格式 ,年/月/日,举例:2020/3/8
文本类型:格式,中文字符;长度范围
数字类型:格式,数字;长度

2、列表默认加载内容及排序
默认加载数据的规则

3、列表分页
默认每页最多显示20条,支持页数切换、上一页、下一页等

4、缺省内容
无数据,默认展示暂无数据,作为缺省页面

5、操作按钮

需求要点及注意事项:
1.需考虑不同大小屏幕,内容的适配情况
2.针对内容宽度过宽,如何处理XXXXX
Case2 搜索查询模块
搜索部分说明
1.搜索字段说明
字段1:精准查询/模糊查询
字段2:精准查询/模糊查询

2.搜索结果说明
排序方式按XXXX排序,数据展示条数XXXX

2.2 查询列表

列表导出

前置条件:系统已开通【智能考勤】插件,且具备【导出明细】权限
主流程说明:
在员工考勤中可以查看品牌下所有门店的考勤打卡数据,根据需求进行数据导出

功能说明
点击【导出明细】进行二次确认,确认后页面弹窗“提交成功”,导出的字段同原型显示的字段,导出标题是“总部员工考勤唯一标识码”
格式如下:


3.表单页面

3.1 基础表单

入口:
位于【XXX导航】-【三级菜单】
前置条件:
需要具备什么权限可访问此页面
默认加载的数据及范围,无数据,则展示缺省页面
流程说明:
1.填写表单信息
2.可选择提交或保存或删除操作
此处可进行文本描述/流程图

原型 需求说明
示例页面
image.png
Case1 表单填写
填写表单内容,内容字段说明如下
标题:
●必填,文本输入框
●默认缺省提示:给目标起个名字
●校验规则:内容全局唯一,<80字符,支持英文、数字、下划线

目标公开:
●必填,单选
●默认选择:部分公开
●可选范围:公开、部分公开、不公开

选择日期
●必填,时间范围选择器
●默认选择:无
●可选范围:支持近三个月选择

需求要点及注意事项:

image.png
image.png
Case2 表单提交
前置条件:新建表单页面,具备保存权限

内容说明:
点击【提交】,进行对应字段校验规则
1.校验成功,提示【新增成功】
提示文案如下:

2.校验失败,Toast提示对应报错信息
报错类型及文案如下:
- 情况1,报错文案:xxxxx
- 情况2,报错文案:xxx
Case3 表单取消
前置条件:新建表单页面,可取消

内容说明:
点击【取消】,关闭当前页面,并不进行表单信息校验和保存

3.2 分步表单

入口:xxxx
前置条件:XXXXX
流程说明:
分步表单共包含三个流程:填写转账信息、确认转账信息、完成

原型 需求说明
示例页面
image.png
Case1 填写转账信息
入口:
位于【XXX导航】-【三级菜单】
前置条件:
需要具备什么权限可访问此页面
默认加载的数据及范围,无数据,则展示缺省页面

流程说明:
1.填写基本信息
2.下一步,进入确认信息

内容说明:
1、填写基本信息,列表字段说明:
标题:
●必填,文本输入框
●默认缺省提示:给目标起个名字
●校验规则:内容全局唯一,<80字符,支持英文、数字、下划线

目标公开:
●必填,单选
●默认选择:部分公开
●可选范围:公开、部分公开、不公开

选择日期
●必填,时间范围选择器
●默认选择:无
●可选范围:支持近三个月选择

2、点击【下一步】,进行内容校验
(1)校验成功,进入下一步【确认转账信息】
提示文案如下:

(2)校验失败,Toast提示对应报错信息
报错类型及文案如下:
- 情况1,报错文案:xxxxx
- 情况2,报错文案:xxx


需求要点及注意事项:

| | image.png | Case2 确认转账信息
前置条件:完成转账信息填写,校验成功,进入当前页面

流程说明:
1.进行表单内容填写,填写内容及字段如下
2.点击提交,进行密码校验
3.点击上一步,回到上一步页面

内容说明:
1.顶部提示文案
确认转账后,资金将直接打入对方账户,无法退回。

2.填写信息,字段说明
支付密码:
●必填,文本输入框
●默认缺省提示:请输入
●校验规则:支持英文、数字、下划线

3.点击【提交】,进行对应字段校验规则
校验成功,进入【完成】页面,后台新增一条添加记录
校验失败,Toast提示对应报错信息
报错类型及文案如下:
- 情况1,报错文案:xxxxx
- 情况2,报错文案:xxx


4.点击【上一步】,回到上一步页面

需求要点及注意事项:

| | image.png | Case3 完成
前置条件:完成【确认转账信息】,点击提交成功后,进入当前页面

内容说明:
1.操作成功提示文案
2.操作成功后,包含以下反馈信息
付款账户、收款账户、收款人姓名、转账金额
3.可操作按钮
再转一笔:点击进入【新建页面】
返回:点击返回到列表页面 |

4.规则说明

排序规则

1,广场,项目展示按照发布的项目的最新、最热、下载量综合排序展示项目。
2,工作台,项目按照用户最近使用的时间先后顺序,降序排列展示。
3,我的收藏,项目按照用户收藏项目的时间先后顺序,降序排列展示。

搜索规则

1,广场中的搜索功能,搜索范围为所有已发布的移动端项目。
2,支持模糊词搜索、大小写、缩写搜索。
3,搜索逻辑为点击搜索,输入关键词后,点击键盘上的“确认”/“回车键”进行搜索。

加载机制

1,打开小程序时,系统自动加载项目内容,用户滑至内容底部时,手动触发加载机制。
2,系统自动加载或用户手动加载,加载逻辑为分屏加载,每次加载两屏项目内容。
3,加载过程中toast提示“获取数据”,内容底部提示:“加载中”,加载完所有内容后内容底部提示:“没有更多”

移动端类

1 刷新机制
2 过程状态

必要的说明: 文档中的原型图,主要借用蚂蚁金服开放的原型文件图片,此处仅为方便文档模板的撰写,不做商业化使用,若有侵权,请联系我更换