前端系统分析模板(或者叫前端设计模板) - pod4g/tool GitHub Wiki
- 需求背景
这一部分,介绍本次项目 / 需求的背景,包括项目提供的业务价值、解决的痛点、业务目标、目标人群等
1.1 需求地址
PRD 地址 / Aone 地址
1.2 业务价值 / 定位 / 目标...(可选)
可介绍自己对于本次项目/需求的价值理解
- 项目人员
项目各角色接口人,包括 PD、前端、服务端、测试、交互、视觉、其他合作方等
- 项目文档
交互视觉(语雀画板 / udemo 链接、图片,推荐图片形式,较为直观)、Basement 迭代地址、服务端系分、依赖库文档等
- 项目排期 / 上线计划
项目各关键时间节点,包括提测时间点、联调计划、详细上线计划、全量时间点
注:若开发阶段具体排期未定,可后续补充
- 详细设计
各个功能点的详细设计方案,包括示意图(字段和页面展示对应)、流程图、接口、对应字段(包括返回的层级结构)、前端处理逻辑、各边界异常条件应对方案等
5.1 功能点 A
5.1.1 示意图 / 流程图
包含如下图:
动作类功能点(包括用户的操作处理、异常逻辑处理等),推荐使用流程图来描述处理逻辑
页面渲染类的功能点,推荐使用示意图(字段和页面展示对应)描述
5.1.2 接口
调用的服务端接口,包括入参和关心的返回值
接口返回内容层级简单的,推荐使用表格展示
接口返回内容层级较为复杂,推荐使用 JSON 格式方便描述
5.1.3 逻辑处理
如果示意图和流程图不能完整表达全部处理逻辑,可将更多细节陈列于此
5.1.4 自测用例 / 测试点(可选)
开发测试时需重点关注的部分,例如边界条件、异常场景处理等
- 风险评估
(可选)项目改动、上线的风险点、性能、安全等
- 稳定性保障
(可选)容量评估、兼容性、回滚计划等
- 监控和埋点
(可选)监控配置、监控平台、需重点关注的监控项、埋点验收等
- 变更记录
(可选)系分评审后需求变更或接口变更记录
- 项目总结 / 复盘
(可选)项目开发或上线后,对整个流程进行的总结、复盘