咸鱼的思考1--如何看待写代码与写文档

问题

新人接手项目时，最怕的就是啥说明都没有，只有代码的项目，运气好的还有人短期指导你一阵，运气差的怕是上来就接手一堆代码，组里也没有人熟悉，这个时候就只能看代码

观点

1. 写文档就是浪费时间
2. 没有文档就是瞎搞

究竟要不要写文档呢？相信各位觉得文档还是必要的，尽管写文档确实很花时间

哪些文档

文档也不是越多越好，文档是为了让开发更快地熟悉项目，但过多的文档，则看不到重点了。结合本人经历的项目列举以下必要的文档：

1. 思维导图
2. 时序图
3. 业务流程图
4. 接口文档
5. 架构图

做产品的同学可能还要写***PRD文档***，这个东西目前没有统一标准

所有的文档需要统一维护，一旦接口变动要及时更新
对于复杂的操作流程，都要说明文档，避免负责这个模块的人一走，其他人都不搞不清楚，动一下就出大问题

个人感悟：写完这些文档后发现自己对项目各模块和功能都很熟悉，因为写文档的同时把实现逻辑都想了一遍，写代码自然没那么困难