必须的文档
- 需求文档
- 接口文档
- 关键算法文档
- 总体架构、设计文档
总体而言：
* 不是那么显而易见的地方；
判断标准：
* 能否在5分钟之内看懂
* 文档是写给别人看的
* 能否做到问题清楚、重点突出、逻辑清楚
* 能否做到言之有物
* 能否做到言简意赅
* 能否做到避免误解
写作方法
* 先写提纲（自顶往下，后填空）
* 反邹
配图指南
只讲一个故事
图中的 字体、留白需要合适
文档的review
文档的reviewer 是一次在大脑中的重放过程
写不好文档的根本原因是对这个问题根本没想清楚
怎么写好的文档