写文档没啥用，别写了！
后记：相信很多程序员都深有体会，别写了写文档真是写文一件痛苦的事情，正如文章中所说，档没需求会变，啥用文档如果不跟着变就会过时，别写了过时的写文文档甚至会产生误导的作用。可是档没呢写文档又是一件不能给自己立刻带来什么价值的事情，累死累活把代码写完，啥用把bug改完，别写了下一个任务就在那里压着，写文还要求写文档，档没这就太要命了吧!所以大家都不愿意写文档，啥用于是WordPress模板别写了就造成了一种怪圈：大家看代码的时候都希望有文档辅助， 但是写文又没人写文档。
我觉得一个项目的档没文档没有必要写得面面俱到，事无巨细，那样确实费时费力，但是有几类文档是必不可少的。首先是需求文档，一般是Use Case的方式，主要描述需求，里边有角色和业务流程，高防服务器正常分支和异常分支，让新人一看就知道这个系统是做什么的。其次是架构文档，主要描述系统有哪些技术组件构成，他们之间是怎么交互的。第三类视项目而定，主要是对于关键模块的描述。
【本文为专栏作者“刘欣”的原创稿件，转载请通过作者微信公众号coderising获取授权】
戳这里，看该作者更多好文
本文地址：http://www.bzve.cn/html/88f65399258.html
版权声明
本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。