• 请不要在回答技术问题时复制粘贴 AI 生成的内容
liuguangxuan
V2EX  ›  程序员

统计帖,请问各位开发的老哥,公司会要求你们写文档吗?

  •  
  •   liuguangxuan · Jan 8, 2023 · 3675 views
    This topic created in 1248 days ago, the information mentioned may be changed or developed.

    最近项目做完了,被公司要求写各种文档,动辄十几个文档,而且要求配各种图(组成图、架构图、流程图等等)。被整的头都大了。

    有点儿好奇其它公司是什么样子的。所以想问一下各位老哥:

    1. 你们公司会要求开发写文档吗?
    2. 分别有哪些文档?
    3. 写文档占开发的时间比?
    20 replies    2023-01-10 00:50:29 +08:00
    ysicing
        1
    ysicing  
       Jan 8, 2023
    需要写
    看需求大小,大需求,写设计方案,数据库结构(DBA 评审),API 文档,测试用例
    cydysm
        2
    cydysm  
       Jan 8, 2023 via iPhone
    我最讨厌两种人了
    1 、不写文档的人
    2 、让我写文档的人


    要写文档
    wu67
        3
    wu67  
       Jan 8, 2023
    只有在上家接了国企的外包时才需要写.
    另外如果给时间, 写也不是不行, 最烦的就压缩工期要你写文档, 写文档的时间不允许写进文档...
    leyfung
        4
    leyfung  
       Jan 8, 2023
    概要设计、详细设计
    815979670
        5
    815979670  
       Jan 8, 2023
    我们开始只是要求写文档,后来我用多余的实际 在文档的基础上再加上流程图 让整个逻辑看起来更清晰
    hhjswf
        6
    hhjswf  
       Jan 8, 2023 via Android
    要啊,项目验收的时候客户会要文档
    yolee599
        7
    yolee599  
       Jan 8, 2023 via Android
    让产品经理写,需求都是他出的他最清楚
    gowk
        8
    gowk  
       Jan 8, 2023
    想问下大家这样的文档你们团队一般保存在哪里?用什么工具
    moonrailgun
        9
    moonrailgun  
    PRO
       Jan 8, 2023
    产品经理要写,开发要写,QA 要写。
    FranzKafka95
        10
    FranzKafka95  
       Jan 8, 2023 via Android
    详细设计文档你总要写吧
    hiugo
        11
    hiugo  
       Jan 9, 2023
    @gowk confluence
    iovekkk
        12
    iovekkk  
       Jan 9, 2023
    会,纳入了季度考核指标
    而且还 TM 非常蛋疼的是先写代码后写文档
    其实也就是为了流程补文档
    不过好处就是可以瞎写,只要内容丰满即可
    7911364440
        13
    7911364440  
       Jan 9, 2023
    接口文档+设计文档
    zhanlanhuizhang
        14
    zhanlanhuizhang  
       Jan 9, 2023
    1 ,非常不喜欢先写代码,后补文档。(感觉对自己就是坑)
    2 ,遇到业务复杂的中大型项目,不写文档,我已经体验过了。业务型 bug ,满天飞各个模块之间的调用好多问题。
    yaphets666
        15
    yaphets666  
       Jan 9, 2023
    写呗,反正按时间算钱,加班写就算了。
    yc8332
        16
    yc8332  
       Jan 9, 2023
    不写。。就写接口文档。。做业务的谁写那个啊。。难道是给人外包做系统吗
    wangerka
        17
    wangerka  
       Jan 9, 2023
    OP 和层里说的都是后端吧,前端很少要求写文档
    exonuclease
        18
    exonuclease  
       Jan 9, 2023
    有一堆 design doc troubleshooting guide 还有各种接口 or 工具的文档 好在活不多有空写
    allgy
        19
    allgy  
       Jan 9, 2023
    只写 API 文档,其他的一律免谈
    gausszhou
        20
    gausszhou  
       Jan 10, 2023
    可信变革...
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   922 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 117ms · UTC 20:46 · PVG 04:46 · LAX 13:46 · JFK 16:46
    ♥ Do have faith in what you're doing.