|
|
51CTO旗下网站
|
|
移动端
创建专栏

写文档没啥用,别写了!

相信很多程序员都深有体会,写文档真是一件痛苦的事情,正如文章中所说,需求会变,文档如果不跟着变就会过时,过时的文档甚至会产生误导的作用。

作者:刘欣|2020-04-03 10:57


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

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

【本文为51CTO专栏作者“刘欣”的原创稿件,转载请通过作者微信公众号coderising获取授权】

戳这里,看该作者更多好文

【编辑推荐】

  1. 2019年11月Github上热门的开源项目
  2. 12月份Github上热门的JavaScript开源项目
  3. PMO心好累?看马蜂窝如何用系统驱动项目管理
  4. 在阿里,新人如何快速上手项目管理?
  5. bug越找越多,19年开源项目中bug数量激增近50%
【责任编辑:武晓燕 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢