不管需求大小，或者是业务驱动还是技术驱动的需求，都有必要写技术文档。

什么是前端技术文档

为什么要写前端技术文档

对自己：

1. 思维结构化，避免考虑不全，降低需求风险
2. 事事有落地，方便复盘回顾，提升个人成长 对合作方：
3. 提高和其他方向同学的沟通效率
4. 多人合作项目，提高开发质量和效率
5. 给出的排期有理有据，避免撕逼

什么时候写

需求初评-》细评阶段写初稿，画框架图

谁来写

技术 Owner 主导，协作方配合完善

如何写技术文档

可实现性、整体架构、具体设计

针对不同类型的需求，技术文档的要求也不一样。

肉眼评估超过 3 天工作量的，一般需要写。

1. 中大型需求：引入

2. 小型需求：比如文案改动、

3. 需求描述（一句话）

4. 目标收益（技术收益/业务收益/可量化）

5. 项目信息（合作方信息/项目资源/技术资料）

6. 需求拆解（模块/功能/需求/技术设计|结构化/不重不漏）

7. 技术方案（技术架构/业务流程/）

8. 需求排期（最小粒度0.5天/+20% Buffer）

9. 测试方案（测试账号/测试环境/需求影响面/研发冒烟测试）

10. 上线方案（灰度策略/AB实验/回滚方案）

11. 复盘总结（数据分析/收益验证/方法沉淀/问题规避）