写文档没啥用，别写了！

更多技术漫画，尽在码农翻身

后记：相信很多程序员都深有体会，写文档真是一件痛苦的事情，正如文章中所说，需求会变，文档如果不跟着变就会过时，过时的文档甚至会产生误导的作用。可是呢写文档又是一件不能给自己立刻带来什么价值的事情，累死累活把代码写完，把bug改完，下一个任务就在那里压着，还要求写文档，这就太要命了吧！所以大家都不愿意写文档，于是就造成了一种怪圈：大家看代码的时候都希望有文档辅助， 但是又没人写文档。

我觉得一个项目的文档没有必要写得面面俱到，事无巨细，那样确实费时费力，但是有几类文档是必不可少的。首先是需求文档，一般是Use Case的方式，主要描述需求，里边有角色和业务流程，正常分支和异常分支，让新人一看就知道这个系统是做什么的。其次是架构文档，主要描述系统有哪些技术组件构成，他们之间是怎么交互的。第三类视项目而定，主要是对于关键模块的描述。

你看到的漫画只是冰山一角，在公众号回复关键字“漫画”可以看到更多精彩文章