05.业务分享的模板
目录介绍
- 01.需求背景
- 02.功能演示
- 03.技术实现方案
- 04.代码 Review
- 05.遇到的难点及解决方案
- 06.吐槽与建议
- 07.参考文档
01.需求背景
- 简述对需求的理解及思考
- 产品业务背景
- 技术背景
02.功能演示
- 对产品需求所实现的功能做完整的交互及视觉演示，帮助其他人对产品需求及使用场景的理解
- 可以采用截图说明或现场演示的方式，如果有复杂的动画需要说明一下
03.技术实现方案
- 从整体角度介绍你的实现方案，可通过设计框图来体现，如流程图、时序图、框架图等等
- 较复杂的项目需要有完整的技术文档输出
- 与服务端的数据通信流程、请求 API 返回的数据结构等
- 异常流程的处理：如网络请求异常、状态同步异常的处理、降级的处理
04.代码 Review
- 对需求的具体实现，需要体现核心代码结构及框架
- 代码UML图，核心代码说明，一些关键代码点说明
05.遇到的难点及解决方案
- 遇到的问题及思考。比如交互难点，技术方案难点，兼容性难点，具体到例子。
- 提供可行的解决方案。怎么去排查的，怎么去解决的，输出有效文档链接
06.吐槽与建议
- 现有业务结构的不足点、代码上的问题、建议、思考等等
07.参考文档
- 你在本次分享准备过程中阅读过的文档链接，如产品文档、后端文档、接手项目时的技术文档等等