需求检查清单

常规需求

字段

• 是否必填
• 是否有默认值，默认值是什么
• 取值来源
• 是否唯一
• 输入类型文本框、搜索框
  • 显示长度
  • 输入长度
  • 非法字符
  • 是否可继续拆分，如“3栋2单元1室”
  • 是否会用于排序
  • 是否包含 emoji 表情符号
  • 是否是搜索框
  • 是否模糊搜索、匹配方式
• 日期
  • 格式
  • 显示格式
  • 仅一个还是开始、结束两个输入
  • 是否包含结束日期
  • 开始、结束是分开还是合并成一个组件
  • 最大值、最小值、最近多少天、多少小时
  • 范围选择是按30天还是31天
  • 数据库时区
  • 精确到年、月、日、时、分、秒、毫秒
  • 是否可以手输，输入非法字符
  • 存储是否是 23:59:59、还是 00:00:00
  • 是否使用时间戳
• 数字
  • 最大值、最小值
  • 是否为整数
  • 是否为小数，小数位数
  • 是否是负数，负数时输入长度
  • 8进制、10进制、16进制、科学计数法
  • 标准单位
  • 输入使用的单位
  • 输出使用的单位
  • 前端显示格式，如：999,999.00
  • 是否货币，是否显示中文大写
• 下拉框
  • 取值范围
  • 下拉顺序
  • 是否支持多选
  • 是否级联
  • 是否会用于排序
  • 前端显示格式
• 单选框取值范围
  • 布局顺序
  • 是否会用于排序
  • 前端显示格式
• 复选框取值范围
  • 布局顺序
  • 是否会用于排序
  • 前端显示格式
• 文件个数
  • 大小
  • 是否生成缩略图
  • 格式
  • 存储时间多久
  • 文件访问权限
  • 前端显示格式

搜索（参考文本框）

• 查询条件、匹配方式
• 查询最大范围
• 是否跨表、跨库、搜索条件是否跨3表、是否跨库
• 排序规则、按 id、时间（mysql时间可能不准）
• 默认分页大小
• 可选分页大小
• 是否可自定义分页大小
• 分页格式
• 是否导出

导入

• 导入文件格式
• 导入文件模板产品需要提供
• 导入文件模板是静态的还是动态的下载
• 导入模板是否需要隐藏的版本信息
• 导入错误是否提供错误原因文件下载、还是提示下就好了
• 导出错误的文件是包含所有记录还是只有错误的记录
• 导入如果一个错误是所有都回滚还是只回滚单个
• 导入记录大小限制、条数限制
• 文件名、标题、列名、列顺序、sheet名、sheet顺序
• 数据量

导出

• 导出文件格式
• 导出模板需要产品给定
• 导出是否分页、搜索条件是否带入
• 导出是否跨表、跨库
• 导出当前页、还是所有页、还是带查询条件的导出当前页、所有页
• 导出多个 sheet 还是单个
• 多个列表是一起导出还是单个导出
• 导出记录大小限制、条数限制、日期限制等
• 文件名、标题、列名、列顺序、sheet名、sheet顺序
• 文件过大怎么办，是否采用异步导出
• 前后端兼容性（如导出文件给第三方公司导入）
• 数据量

报表

• 时间维度、区域维度、部门维度等
• 如果是时间维度分隔跨日、月年怎么判定归属，时间字段是按创建时间、还是支付时间
• 第一次执行、手动重复执行时选择的时间段的中间时间区域变动了、部门、人员变动了怎么办
• 是否实时、定时
• 是否跨表、跨库
• 数据量大小、查询范围
• 是否依赖，如：年依赖月、月依赖日
• 重跑是否会改变历史、或者历史数据在重跑时已经被改变无法恢复
• 是否提供手动执行按钮、执行的话是实时还是异步延迟通知
• 统计类、分析类需求是否需要查询历史记录，历史记录有 id 但是内容已不存在怎么办
• 报表需求变更后是否需要修正历史已经生成的报表数据
• 报表需求变更后前后端兼容性（如导出文件给第三方公司导入）
• 是否有导出功能
• 是否有导入功能

对接需求

前置

• 对接人员
• 开始对接时间、结束对接时间
• 开始联调时间、结束联调时间
• 发布上线时间
• 是否有试运行、试运行时间
• 时区、时钟同步问题，是采用本地时间还是远程时间
• 是否是重要操作接口，是否需要记录双方接口操作人
• 金额出现丢失责任问题
• ak、sk 怎么获取，后续如何重置更新
• 功能是否需要设计开关

接口

交互、协议

• 模型关系是否清晰，是一对一、一对多、多对多
• 使用什么协议：http、https、web socket、web service、tcp、udp自有协议
• 心跳机制
• 接口超时时间
• 默认编码是什么、是否支持emoji表情
• 接口是否有版本号、是否定义接口停止服务下线码
• 接口版本信息
• 接口签名验证算法、SSL证书过期时间
• 数据加密算法是什么
• token 有效期、失效获取方式
• token 可调接口的权限范围
• 接口是否幂等
• 是否多步骤交互接口、各个接口交互流程
• 是否提供相应查询成功、失败、错误、执行中接口
• 兜底接口、对账接口
• 是否提供异步通知功能、接口

参数

• 是否分页，分页参数是从0还是1开始，最大分页大小
• 参数是否必填、默认值、长度、格式、取值范围、上下参数关系
• 字段是否具有唯一性
• 每次调用（如任务下发后查询需求）是否需要提供唯一凭证供后续查询状态变更

返回值

• 返回值是否一定存在
• 返回结果是否 NULL，是单个值还是列表
• 每个返回结果枚举都是同步、都是异步、部分同步、部分异步
• 是否有文件（参考文件需求）、http 文件保存天数、是否可无认证下载查看、文件权限

错误处理

• 是否有告警、是否有统一 request id
• 错误码、错误流程处理
• 发生错误是否有工单进行人工处理方案
• 错误、不可用容忍度
• 调用限制，如次数、IP 白名单

性能

• 性能要求

安全

• 敏感数据怎么处理
• 日志保留天数

文档

• 联调接口是否已存在、还是需要重新开发
• 联调接口文档及给定时间、文档内容后续是否会变动
• 接口文档是否在线、离线
• 是否有提供对应语言的签名算法示例代码

调试

• 是否可以我方直接造数测试
• 调试是否需要硬件设备（如车辆、充电桩）及准备
• 调试是否涉及金钱，需要提前沟通协调财务，
• 调试出现电压过大等导致设备损坏责任问题
• 生产环境证书和联调证书是否一致
• 联调地址、生产地址
• 联调环境、生产环境各个接口是否有差异
• 联调环境、生产环境是否有 IP 白名单
• 联调账号注册