前端系分文档

为什么要写系分文档

之前做需求,我只是比较被动的跟产品开完会,等设计出设计稿,等后端出接口文档,两个一整合就上线了。

然而最近我来到了互动交互小组,随着需求的越来越复杂,前端扮演的角色越来越重要,工期越来越紧张,很多时候项目的难点和瓶颈出现在前端,还是以前那样悠闲的等设计稿等接口才开工是行不通的。

这时候我们需要前端系分文档。

系分文档的好处

  • 让前端更了解需求,提前发现需求不合理的地方
  • 做好依赖链接的整理,避免四处翻找资料
  • 更细的拆分模块,合理评估工作时间。
  • 更了解业务方的目标和相关方的计划
  • 画出交互流程图,加深对交互流程的掌握
  • 找出技术难点,提前暴露风险
  • 做好上线的准备,避免出现意外
  • 方便事后复盘

系分模板

修订历史

版本号/作者/提要/日期

需求背景

包括业务价值、痛点、用户等

需求目标

项目人员

各个角色,合作方的职责

文档

git仓库、设计稿、翻译文案、依赖等地址

排期计划

技术设计、设计稿完成、联调、提测、UAT、上线等时间点

工作量拆分

技术设计

流程图、时序图、技术难点、特殊动效的设计、接口、测试重点

风险

兼容性、工作量、性能、人员等

稳定性、兼容性

灰度与应急方案

埋点监控

性能上报,事件埋点,错误监控

发布checklist

总结复盘

支持作者

如果我的文章对你有帮助,欢迎 关注和 star 本博客 或是关注我的 github,获取更新通知。欢迎发送邮件到hpoenixf@foxmail.com与作者交流