后记:相信很多程序员都深有体会。写文档真的是一件很痛苦的事情。正如文章所说,需求会发生变化,如果不遵循,文档就会过时。过时的文件甚至可能具有误导性。影响。但是,写文档是一件不能立即给自己带来任何价值的事情。写完代码,改完bug,接下来的任务就按在那里了,要求写文档。它是可怕的!所以大家都不愿意写文档,这样就形成了一个怪圈:大家看代码的时候都希望有文档来辅助,但是没有人写文档。我认为项目的文档没有必要全面和注重细节。确实费时费力,但是几类文档必不可少。首先是需求文档,一般是UseCase的形式,主要描述需求,包括角色和业务流程,正常分支和异常分支,让新手一看就知道系统是干什么的。其次是架构文档,主要描述系统的技术组成部分以及它们之间是如何交互的。第三类依项目而定,主要针对关键模块的描述。【本文为专栏作家“刘欣”原创稿件,转载请通过作者微信获取授权公众号coderising】点此查看该作者更多好文
