好讨厌写文档啊,各位 coder 平常都要写什么文档啊?

2023-09-18 09:15:51 +08:00
 lpf0309

快烦死了,又是方案设计、又是技术设计、关键是东西都不知道能不能做出来呢,又要写专利、论文,干着总工程师的活,拿着助理工程师的工资。每到写文档时,就开始效率低下,是不是干研发都得写很多文档啊。

4333 次点击
所在节点    职场话题
43 条回复
MoonWalker
2023-09-18 10:36:56 +08:00
太能理解了,什么东西没有,开个 1 小时左右的会,大概讲下背景然后就开始让你写方案设计,功能清单
wqhui
2023-09-18 10:51:44 +08:00
熟练之后就写的很快了,都是按套路写,只要时间不紧就行,一般只给生成的 api 文档用来对接
billzhuang
2023-09-18 11:06:01 +08:00
都在国企了,
rehoni
2023-09-18 11:18:19 +08:00
国企了,自然什么都写,俺也一样
qiaobeier
2023-09-18 11:25:54 +08:00
用 Copilot 自动生成注释,然后用 JavaDoc 自动生成文档文件。
wobuhuicode
2023-09-18 11:29:03 +08:00
AI 文档
Cu635
2023-09-18 11:30:00 +08:00
文档和注释其实最终还是给自己写的,该认真写就认真写。工资给的少就别把文档精简一下呗。
#17
说白了,还是封建社会那一套,技术人员就是包身工,官老爷才配当人。

@cleveryun #3
也有可能是公司之前缺乏文档,现在在补课。

@flame666 #13
还是看内部有没有文档了,有的时候文档是故意不给客户或者不免费给客户的。连内部文档都没有,才是“野路子”。
DamonLin
2023-09-18 11:41:56 +08:00
文档还是要写的,比如一些复杂的业务场景,各种判断流程,还有对接第三方 api 引用的数据,前人种树后人乘凉。我也很讨厌写文档
lpf0309
2023-09-18 11:46:21 +08:00
@lzgshsj 感觉还不如小作坊,对接找不到人,需求靠领导传达,然后需求说明还是自己写的
taogen
2023-09-18 12:22:30 +08:00
小公司:基本没有文档
WebKit
2023-09-18 12:27:52 +08:00
我们必须写文档,任何模块都先写文档。代码有修改也要先同步到文档。我觉得挺好。可以预估更长的时间。
lDqe4OE6iOEUQNM7
2023-09-18 13:24:55 +08:00
现在有了 ai,不就几分钟的事情吗
szzadkk
2023-09-18 14:33:40 +08:00
接手一个项目的时候都希望有完善的文档,然后开发的时候都不喜欢写文档,死结,无解
luoshuimumu
2023-09-18 15:40:04 +08:00
文档还是有必要的,国企有一套严谨的验收流程,文档先行能在一定程度上起到保交付和预估风险的作用
设计文档出来了就知道能不能做出来了,不验证可行性直接撸代码只适合单打独斗的小项目
ming168
2023-09-18 15:43:26 +08:00
什么可研报告,模块报价,施工进展报告,验收文档。。。辣鸡国企
luoshuimumu
2023-09-18 15:45:19 +08:00
平时文档不算多,如果是自己写,认真写一次就行了后面可以复用。不需要一开始就严谨成文,可以做的过程中慢慢补,但是大体的设计思路和交付的关键节点要先明确下来。

文档还是有必要的,国企有一套严谨的验收流程,文档先行能在一定程度上起到保交付和预估风险的作用。
darklost
2023-09-18 17:28:47 +08:00
主要是钱给得不够
Liftman
2023-09-18 21:05:22 +08:00
你先花九块九去淘宝买一个方案、标准等等文档的合集。然后每次要写的时候。先把模板扔给 gpt 。然后再把你的细节要求扔给 gpt 。要求填充合并就行了。
plasticman64
2023-09-18 21:08:25 +08:00
蹲国企里就做好螺丝钉就行
maplezzz
2023-09-18 22:47:46 +08:00
项目可能维护的时间长,对代码健壮性,稳定性要求高的项目写写开发文档还是很有必要的;比较简单的其实不是太所谓。我现在做的有的已经维护了好几年了,有时候碰到问题翻翻之前的文档还是挺有用的。

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

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

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

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

© 2021 V2EX