V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
flamiNNgo
V2EX  ›  问与答

技术文档一式两份是不是比较好

  •  
  •   flamiNNgo · 2023-07-10 09:48:51 +08:00 · 1339 次点击
    这是一个创建于 488 天前的主题,其中的信息可能已经有所发展或是发生改变。
    一份自己看,规整、详细、啥都有
    一份公布用,主要是应付文档要求、同时隐藏一部分细节
    自己写可以不用那么规范,同时自己写的,看到细节能知道是什么
    提升替换成本?
    rongpx95
        1
    rongpx95  
       2023-07-10 10:30:49 +08:00
    有些麻烦,我在想,都详细点会有什么问题?
    israinbow
        2
    israinbow  
       2023-07-10 10:44:41 +08:00 via Android
    公布用的隐藏细节用注解不就行了, 整两份给自己加工作量和心智负担何苦呢.
    pkoukk
        3
    pkoukk  
       2023-07-10 10:47:08 +08:00
    文档最常见的问题是经常跟不上代码的版本( hotfix 或者小更新,不总是会立刻更新文档),写两份文档更是会扩大这种问题
    你说的那些细节,也没必要非要放到文档里,找起来改起来也不是特别方便,如果只是给自己看的话,我一般会写在更新日志/发布日志里
    提醒一下自己找回记忆
    zhenghuiy
        4
    zhenghuiy  
       2023-07-10 11:04:41 +08:00
    空想的时候当然啥都行,但真正去做的时候,一定会受不了这个额外的工作量。
    KDr2
        5
    KDr2  
       2023-07-10 11:12:17 +08:00
    这不是一式两份,这是两式。
    flamiNNgo
        6
    flamiNNgo  
    OP
       2023-07-10 11:21:16 +08:00
    @zhenghuiy 是的,hhhh
    @KDr2 是的
    @pkoukk 有道理
    @israinbow 有道理
    @rongpx95 主要是增加自己的替换成本
    israinbow
        7
    israinbow  
       2023-07-10 11:26:15 +08:00
    @flamiNNgo #6 什么是 "自己的替换成本" ? 你是不是再找 "不可替代性" ? 那你不写不就完了🤔
    crazyTanuki
        8
    crazyTanuki  
       2023-07-10 11:26:29 +08:00   ❤️ 1
    感觉你这是在整自己,不是整别人
    DigitalG
        9
    DigitalG  
       2023-07-10 14:04:04 +08:00
    如果是自己选择工具记录,可以用能加注释的文档方案,公布用导出的 markdown 或者 pdf
    zexinwu84
        10
    zexinwu84  
       2023-07-10 14:18:58 +08:00 via Android
    一式两份不是这个意思
    opengps
        11
    opengps  
       2023-07-10 14:37:58 +08:00
    带有公司资料的,干脆别发布,一不小心都是在给自己挖坑
    xiangyuecn
        12
    xiangyuecn  
       2023-07-10 14:57:30 +08:00
    放心,自己写的代码,别说别人,过段时间自己都不愿意去看🐶
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1942 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 102ms · UTC 00:38 · PVG 08:38 · LAX 16:38 · JFK 19:38
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.