管人管项目 - 要写文档 ¶
作者：KK
发表日期：2017.2.24
可视化文档最受欢迎 ¶
我暂时认为最有效的文档是可视化文档，就是画着一个个圈圈框框连接几条线的那种，让人一看就能在脑袋里构想出一个基础的业务模型
甚至和客户沟通确认需求的时候，如果有图呀表呀、设计呀原型呀之类的给他们看，这样会让他们更快地点头或摇头，而不是等他们思考分析，最后得到更准确的答复：行 or 不行
文档让新成员更快速了解项目 ¶
假设做的是一个商城，我认为需要的文档有：
用户注册流程
用户购物流程
后台发货流程
XX优惠方案规则说明
系统架构文档
系统重点模块摘要（再每个模块项目自己适当配置详细文档或不配置）
涉及的第三方接口说明文档
商品搜索引擎介绍文档
用户消费建模说明文档
重点抽象层说明（为什么要抽象，考虑什么，未来扩展建设注意要实现什么）
根据项目的实际减少或增加更多文档，这样能让未来新加入团队的成员更快速方便地上手项目，而并不是只能手动操作一遍，甚至是慢慢摸源代码
文档让程序员头脑更清醒 ¶
而维护开发的时候，程序员总会在流程图、关系图上更清楚地了解到自己所写的代码处于哪个位置，不应该超越哪个范围，写出更合理的模块化代码
特别是一些复杂的流程，一定要有流程图！不然基本就只有当初做的程序员懂，后面加入的程序员都不是很敢去修改或重构，不熟悉流程，怕做错
尽量挤时间写文档 ¶
说没时间一般是假的，上面提到的文档我就宽限到8小时写一份吧，4个晚上就能凑够8小时了，看看团队成员有多少个晚上不用加班？
如果要求周加2个晚上的班，这4周就能加够8小时把一份文档搞定了
现在可以没文档，但是要备忘，后面慢慢安排时间补
有心的话要写文档不难，重点是愿不愿意挤时间，这对项目和团队都有极大好处
没有文档的后果 ¶
如果你做过几年了，经历过一些团队了，有没有发现后面产品越来越难维护，新人越来越不熟悉这个系统，老员工总是在“处理核心模块”
责任事情难以分摊给新人，带新人的成本也越来越大……最后甚至没人敢动这个系统了都有可能？
画UML我多数用Visio ¶
说完了