程序员们,大家喜欢写文档吗?

2023-07-28 11:25:32 +08:00
 liyiming2002

文档之于程序员,是很矛盾的事情。程序员非常不喜欢写文档,但又非常讨厌别的程序员不写文档。

朋友们可以关注下我的个站:www.icodebook.com

公众号:漫话软件设计。

《漫画程序员涛哥》会在公众号及个站第一时间更新。欢迎大家关注~

往期漫画:

《改个 Bug 要多久?大家有没有过于乐观被打脸的经历》

《程序员错觉之出差下周就回来》

《假如让程序员去换灯泡》

〈程序员错觉之这个需求两天搞定》

我觉得推崇“代码即文档”外,一些必要的设计文档也是必不可少的。另外也不能完全迷信代码的文档能力,这需要较高的水平和经验。一些关键业务的代码可能也需要配以文档。但文档不宜过细,否则需要频繁改动,但是无人维护就会过时。

3660 次点击
所在节点    程序员
31 条回复
brader
2023-07-28 11:27:18 +08:00
让我写文档的我都是觉得有病
sankooc
2023-07-28 11:36:07 +08:00
java 程序员真不需要写文档 特别是 springboot 写不出什么花样
LxnChan
2023-07-28 11:36:54 +08:00
最不喜欢两件事:
1.不写文档的人
2.写文档
xudaxian520bsz
2023-07-28 12:25:12 +08:00
文档要实时,数据库中的字段要有描述,接口需要通过工具生成文档,反正我是用 apipost --> runnerGo ,香
yolee599
2023-07-28 13:09:33 +08:00
写啥文档,doxygen 直接生成
opengps
2023-07-28 13:47:45 +08:00
我喜欢为优秀的接口设计写文档,这种文档本身极其需要技术水平
我讨厌那些繁琐的接口文档,重复量太大
AoEiuV020JP
2023-07-28 14:02:11 +08:00
一次性的不需要更新维护的文档我倒是不介意写,
elechi
2023-07-28 14:05:59 +08:00
挺喜欢写的,只要时间充足
janwarlen
2023-07-28 14:12:13 +08:00
只要给我时间,我甚至想画流程图...
cedoo22
2023-07-28 14:21:05 +08:00
自从用来 copilot, 写文档 反而效率更高 :)
star7th
2023-07-28 14:22:23 +08:00
在这里顺便推荐一个很方便写文档的工具

为的就是解决这些麻烦

https://www.showdoc.com.cn

帮助介绍: https://www.showdoc.com.cn/help
cndydb
2023-07-28 14:47:24 +08:00
正在写····
huangqihong
2023-07-28 15:03:08 +08:00
最不喜欢两件事:
1.不写文档的人
2.要我写文档的人

现在出差去培训,要写项目周报,写培训文档,写反馈意见表
honmaple
2023-07-28 15:06:00 +08:00
曾经在某事业单位遇到过五天时间,只给一天开发和测试,剩下四天不是在写文档的路上,就是在对文档和改文档的路上。嗯,对的是字号大小,改的是流程图颜色,具体内容提不上嘴,反正要突出一个参与感。。。
csw3983931
2023-07-28 15:15:12 +08:00
想问一下这种漫画是怎么做的,能具体讲讲不 ? @liyiming2002
coder1741
2023-07-28 15:17:50 +08:00
不喜欢 写文档的都爬
hzz2
2023-07-28 16:57:15 +08:00
给时间就写,不给时间就不写
Orenoid
2023-07-28 17:02:34 +08:00
喜欢,但要给时间
hpu423
2023-07-28 17:43:56 +08:00
现在大环境写文档,不怕被裁?
chengkai1853
2023-07-28 18:30:00 +08:00
都 Ai 时代了,让它去写

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/960473

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX