博主：爱码叔
个人博客站点： icodebook
公众号：漫话软件设计
微博：程序员涛哥
专注于软件设计与架构、技术管理。擅长用通俗易懂的语言讲解技术。对技术管理工作有自己的一定见解。文章会第一时间首发在个站上，欢迎大家关注访问！

各位开发同学，对于写文档这件事，你们怎么看？

这是一个很矛盾的事情，程序员非常不喜欢写文档，但又非常讨厌别的程序员不写文档。

正所谓己所不欲，勿施于人。作为有职业操守的程序员，需要认真写文档、写高质量的文档。

有的同学这时候会说了：代码既文档！

没错，不过并不代表代码写的足够表意就不需要文档了。在我看来这句话只是指导我们代码要写的漂亮，别人能够看懂。就像写小说，起码行文是通顺连贯的。
但是！有些时候我只想知道小说的骨架是什么、故事线是什么、主要人物有哪些。当然我可以读一遍10万字的小说，再自己总结出来，但是这样的效率非常低下。

系统设计文档也是一样的作用。有的时候你只是想了解某个模块的设计以及技术、业务上下文。一行行看代码非常耗时，而且容易陷入细节。另外一些复杂的程序设计，就像小说使用了倒序、插叙 ，直接读容易被绕进去。通过文档能够直接说明采用了什么设计模式，应该怎样去看代码。

千万不要做不写文档被自己鄙视的那个程序员！