前端方案评估规范
方案设计
# 前端方案评估规范
# 目的
- 有效率的、高质量的完成需求
- 有目标、有标准、有沉淀的做好任务
- 减少遗漏需求,减少返工次数和任务量
# 步骤
- 页面级分解(按页面分块。包括最基础的html、css、js编写部分)
- 公共模块(包括重要模块、可重用模块、通用解决方案)
code reiview
部分估时及时间- 重要模块、可重用模块、通用解决方案文档
- 风险点评估
- 方案预研评估
- 新项目还需要做容器申请
- 接口对接人、接口传参及回参
- 自测(ui自测,功能自测)
- 埋点
# 模板
# 需求背景
- 描述需求提出的原因,明确需要解决的业务问题。
# 需求目标
- 了解业务目标,了解所做的工作对业务产生的价值,并结合目标,进行复盘。
# 核心业务流程
- 前端可以通过页面流程图的方式梳理核心业务流程。
# 技术难点分析
- 分析前端实现中涉及到的技术难点,描述相关的调研情况,以及最终的技术选型。比如营销页面中涉及动画,该如何实现?调研后又该选择哪种方案?
# 页面和功能拆解
- 可以用思维导图的方式,拆解前端页面以及各个页面中的具体功能模块。
# 接口和状态设计
- 和后端协商接口定义,并基于前端的 UI 模型设计状态的数据结构。
- 可以利用
Yapi
或者Swagger
等工具,接口约定是联调顺利的重要保障。
# 工时和风险评估
- 需要考虑到技术调研、编码、联调、自测、文档、埋点、code review 等时间,评估开发工时,并明确可能的风险点。
# 方案评审检查点
# 扩展性
- 方案是否适用于多个业务场景
- 是否考虑到公用方法的复用
- 是否考虑到页面组件的复用
- 是否考虑到页面功能的可扩展性(例如表格是否支持后续增加排序功能、表格是否支持后续新增列等)
- 是否考虑到方法传参的可扩展性(例如方法可传多个参数,还是传一个对象参数)
# 维护性
- 项目选用的前端框架及打包工具是否合理,方便维护
- 项目测试环境和正式环境接口切换是否可配置,方便发布上线
- 项目选用的第三方工具库是否合理,方便维护
# 可靠性
- 是否需要兼容IE浏览器
- 是否依赖第三方库,以及第三方库是否安全
- 是否考虑到页面被缓存的情况
- 页面请求是否合理,是否有不必要的请求(不能轮询)
- 是否考虑到请求加锁的情况
- 页面请求是否需要取缓存
- 是否涉及到请求跨域的情况,及处理方案
- 是否有考虑到页面的访问量
- 是否考虑到接口返回数据的容错
- 是否考虑到页面投放位置,包括启动页、首页banner、消息push、微信环境等
- 是否考虑到
xss
注入的情况