WHAT - 做什么事情
- 梳理文档结构
- 文档能力培训
- 完善关键系统文档
- 建立文档机制
WHY - 为什么做这个事情
- 个人层面
- 好的文档能力，可以帮助开发者理清思路，提升代码质量。
- 项目层面
- 从项目立项开始，制定目标，拆解任务，依赖识别，风险控制，结果验证等一系列事项，都需要有文档落地，确保每一环节能跟踪和检验
- 减少理解偏差，提升沟通效率
- 团队层面
- 经验有沉淀，可传承
WHEN - 什么时候做
文档应当涉及到每一个环节，事前有计划、事中有跟踪、事后有总结。
- 架构设计输出、项目计划拆解 -- 前置
- 规范流程 -- 前置经验，过程中完善
- 学习记录、实践总结 -- 后置
WHO - 哪些人参与
须全员参与。 前期由文档能力强的带领其他同学推进，最终都能具备好的文档能力
HOW - 具体如何来实施
按照 PDCA方法论参考 的方式推进实施，经过多次循环，最终让团队的文档能力达到较好的水准。
Plan - 计划阶段
- 目标
- 专项文档全覆盖
- 跑顺版本迭代中的技术文档流程
- 补充现有关键系统的文档
- 建立文档机制
- 计划
- 每个周期限定 1 个月
Do - 设计和实施阶段
- 明确责任人，按计划进行实施，期间需要安排文档能力培训与指导。
Check - 检查阶段
- 每周进展同步，文档质量检查
Action - 处理阶段
- 根据检查结果，把成功的经验总结出来，指定相应的标准；把没有解决或新出现的问题，转入下个PDCA循环去解决。
