V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
lpf0309
V2EX  ›  职场话题

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

  •  
  •   lpf0309 · 2023-09-18 09:15:51 +08:00 · 4274 次点击
    这是一个创建于 402 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    43 条回复    2023-09-19 14:37:07 +08:00
    balabalaguguji
        1
    balabalaguguji  
       2023-09-18 09:18:12 +08:00
    易文档,开发者写文档好帮手 https://easydoc.net
    Jammar
        2
    Jammar  
       2023-09-18 09:19:27 +08:00
    gpt
    cleveryun
        3
    cleveryun  
       2023-09-18 09:27:12 +08:00 via Android
    是不是公司工作节奏慢,所以整出来这么多文档是需求
    Jaosn
        4
    Jaosn  
       2023-09-18 09:28:56 +08:00
    代码未动,文档先行
    Davic1
        5
    Davic1  
       2023-09-18 09:29:02 +08:00   ❤️ 5
    看这个描述你讨厌的应该是给的钱太少。
    carolhai
        6
    carolhai  
       2023-09-18 09:31:35 +08:00
    喂你吃个大饼,为以后总工程师积攒经验
    version
        7
    version  
       2023-09-18 09:46:56 +08:00
    文档不是产品写的么.
    lpf0309
        8
    lpf0309  
    OP
       2023-09-18 09:47:31 +08:00
    @cleveryun 国企传统行业,项目规章制度这么定的
    lpf0309
        9
    lpf0309  
    OP
       2023-09-18 09:49:14 +08:00
    @version 不太懂,应届生进的国企,产品、算法、开发啥都干。
    wu67
        10
    wu67  
       2023-09-18 09:49:36 +08:00
    所以我找了份没那么多条条框框的, 写不写注释都没人理,
    当然, 我写注释. 至于文档, 我接手的时候也没文档, 有心无力, 还不如把注释写详细点.
    version
        11
    version  
       2023-09-18 09:52:57 +08:00
    @lpf0309 那没办法了..企业定位不一样
    普通企业产品有限..都是看成品...老板开会 => 产品记录 => 技术经理过目删减 => 评审会议 => 开发 => 测试验收完工
    国企不一样.写各种文档.调研.最终要评估..审批.动手写代码应该很久很久.
    lifesimple
        12
    lifesimple  
       2023-09-18 09:59:48 +08:00
    给时间就行,写啥不是写
    flame666
        13
    flame666  
       2023-09-18 10:03:14 +08:00   ❤️ 1
    稍微正规点的交付性项目都是必须要有文档的。
    不写文档和野路子差不多。
    codeself
        14
    codeself  
       2023-09-18 10:03:40 +08:00
    国企啊,那还有啥好说的 🍋
    lpf0309
        15
    lpf0309  
    OP
       2023-09-18 10:20:19 +08:00
    我是想问问,大家都要写什么文档,好写不,如果都要写花太多时间在写文档上,我想直接放弃这个行业了。
    54xavier
        16
    54xavier  
       2023-09-18 10:25:18 +08:00
    我只写开发文档还好
    lpf0309
        17
    lpf0309  
    OP
       2023-09-18 10:27:03 +08:00
    @codeself 都说了,干着总工的活,拿着助理工程师的工资。国企里爽的是那些机关部门,搞研发的是又要出成果,又要服从各种制度的管理。
    LitterGopher
        18
    LitterGopher  
       2023-09-18 10:27:16 +08:00
    除了 README 其他的都不写——注释应该不算文档。
    lzgshsj
        19
    lzgshsj  
       2023-09-18 10:30:54 +08:00
    不是行业不行业的问题,你在国企任何行业都要文件俱全……
    建议换个私企小作坊那种,跟老板称兄道弟,跟同事当家人处的,可能比较适合你。代码突出一个能跑就行,需求靠口头通知,对接看微信记录,离职后哪管洪水滔天。
    codeself
        20
    codeself  
       2023-09-18 10:32:53 +08:00
    @lpf0309 说实话,都国企了,多少程序员都羡慕不来的.
    你说的那些文档,多少都是敷衍性质的,gpt 不香吗?
    你不说我不说,领导咋知道你 gpt 写的?
    MoonWalker
        21
    MoonWalker  
       2023-09-18 10:36:56 +08:00
    太能理解了,什么东西没有,开个 1 小时左右的会,大概讲下背景然后就开始让你写方案设计,功能清单
    wqhui
        22
    wqhui  
       2023-09-18 10:51:44 +08:00
    熟练之后就写的很快了,都是按套路写,只要时间不紧就行,一般只给生成的 api 文档用来对接
    billzhuang
        23
    billzhuang  
       2023-09-18 11:06:01 +08:00
    都在国企了,
    rehoni
        24
    rehoni  
       2023-09-18 11:18:19 +08:00
    国企了,自然什么都写,俺也一样
    qiaobeier
        25
    qiaobeier  
       2023-09-18 11:25:54 +08:00
    用 Copilot 自动生成注释,然后用 JavaDoc 自动生成文档文件。
    wobuhuicode
        26
    wobuhuicode  
       2023-09-18 11:29:03 +08:00
    AI 文档
    Cu635
        27
    Cu635  
       2023-09-18 11:30:00 +08:00
    文档和注释其实最终还是给自己写的,该认真写就认真写。工资给的少就别把文档精简一下呗。
    #17
    说白了,还是封建社会那一套,技术人员就是包身工,官老爷才配当人。

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

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

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

    文档上面敲完的橡皮图章,是到时候撕逼起来的一大证据
    zw1one
        42
    zw1one  
       2023-09-19 13:51:42 +08:00
    文档分有效文档和 shit 文档,你说的应该是后者。
    4kingRAS
        43
    4kingRAS  
       2023-09-19 14:37:07 +08:00
    应届生没经历过扯皮,所以觉得文档没用,文档 邮件 纪要就跟谈生意时的合同,公章 发票一样。没出事时岁月静好,一出事时,每个字都给你翻出来看。尤其国企,你看着办吧
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1216 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 36ms · UTC 23:23 · PVG 07:23 · LAX 16:23 · JFK 19:23
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.