写需求文档时值得注意的小细节

显示逻辑

数据

首先是需要明确数据源取自何处，其次是数据的格式如何规定，以及数据的输入输出内容如何排序等。以数据格式的规定为例，我们需要注意数值的字符长度、精确到几位小数、数值为0和空时如何展示。东财的指数行情表便将数字部分控制在4位数，超过则以万、亿等处理。

静态展示

静态内容的展示需要注意大小屏占比、大小极限值等问题。平铺的内容还好，存在多层内容，比如悬浮的就很容易出问题。比如东财的这个“今日机会”悬浮模块，在大屏时是可以完美显示的，但是到了小屏就会出现这种头部被遮挡的情况。

动态展示

动态展示主要注意显示和隐藏的场景。比如说按钮的hover状态是否要有动效、Banner以什么样的频率滚动、toast提示持续多久等等。

交互逻辑

触发机制

交互动作是在哪个区域触发、触发频率是否要做限制。比如我们查看微信的普通视频，点击空白区域会退出全屏，而点击视频号的空白区域则是使视频暂停。

触发时

在触发时需要注意加载方式、是否进行校验以及需要校验的内容、跳转是什么逻辑、交互有何变化等。比如东财近期的金融挑战赛，在进入页面时即进行了登录验证，未登录时按钮显示的是“我要参赛”，吸引用户参赛，或提高比赛结束时用户的交互欲望（即使比赛结束了也显示的是“我要参赛”，而不是显示“比赛结束”并关闭下一层交互）。已登录时则根据用户具体的参赛结果展示，例如“我要观摩”“预约成功”等。

触发后

触发后是否要展示进度、按钮状态是否变化、多次点击时如何展示，以及对交互结果是否要进行反馈（例如成功、失败、空值等）。我们经常看到的做网赚任务时的倒计时或者进度条则是一个很好的例子。

其他小细节

登录

是否需要验证登录状态，需要哪个层级的登录（uid、pid），唤起的是交易账号绑定登录还是交易登录。

权限

该功能是可以游客登录，还是需要uid、资金账号在线？对应角色可看到什么内容，做什么操作？如果账户多端登录时，账号是否互斥？

加载

何时加载、加载范围、加载方式（自动/手动）、加载数量、异常提示（加载失败、加载成功、加载不出内容）等。

刷新

刷新场景（页面进入、返回、提交信息、下拉、刷新按钮等）、刷新方式（是否需要先清空、还是先请求回来之后再替换展示）、异常提示（刷新失败、刷新成功、刷新不出内容）。

缓存

缓存对象、缓存数量和范围、缓存位置（客户端、服务端）、如何清理缓存（自动/手动）。

中断

数据是否变化、页面是否跳转、以及如何提示。

网络情况

网络速度可分为2G/3G/4G三种类型啊，另外还分为wifi和非wifi的情况，不同网络状况如何提示（视频类功能考虑较多）。

关于异常处理可以看看我之前的一篇文章

提示和指引

是否需要挂公告、公告样式是什么？是否需要针对首次进入的客户展示新功能指引的蒙版（新功能的使用指示），样式是怎样的？

删除

逻辑删除还是物理删除？

物理删除：直接从数据库层面彻底删除，删除的数据无法找回；

逻辑删除：仅仅是逻辑和界面展示上删除，数据库中还存有该数据，必要时可以恢复。

退出

退出登录、退至后台运行、杀死程序、关机等情况发生时对应的数据同步、数据中断都该如何进行。

安全性

高隐私数据不考虑本地存储，账号展示掩码，数据传输加密。例如用户银行卡号，平时掩码展示，可通过短信验证码方式查看全部卡号。

埋点

埋点代码、上报方式等。

多部门协同

接口由分别由哪些部门提供，具体对接谁。

版本

主要考虑版本升级后遗留老数据是否会有影响，该如何做迁移，该如何取舍的问题。