写文档没啥用,别写了!

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

 

[[320955]]

 


 

 

 

 

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

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

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

 

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

 

责任编辑:武晓燕 来源: 51CTO专栏
相关推荐

2023-12-30 08:16:34

Django权限控制

2021-08-28 23:15:52

5G4G手机

2020-04-07 10:31:48

操作系统程序员数据

2011-05-25 17:17:54

前端开发

2021-04-19 11:27:25

用户画像数据

2020-02-04 16:37:17

k8s 相关应用

2016-11-22 14:12:13

2022-07-13 17:47:54

布局Flex代码

2023-01-04 07:33:34

机器代码人工智能

2020-09-18 06:52:36

电子书网盘

2020-08-07 12:30:36

Web服务器python

2021-05-14 17:09:21

Python工具代码

2023-02-09 16:57:25

微软AI机器人

2022-03-24 07:57:58

Python水果忍者游戏

2020-08-31 08:45:43

多表查询SQL数据库

2011-04-25 14:19:26

喷墨打印机

2024-02-04 08:43:20

源码线程池缓冲

2017-07-25 08:54:26

前端JsxVue

2024-02-01 08:21:40

2021-09-08 08:34:37

Go 文档Goland
点赞
收藏

51CTO技术栈公众号