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

写文档比写代码难多了

  •  
  •   heboy · 2020-09-04 16:52:46 +08:00 · 2045 次点击
    这是一个创建于 1533 天前的主题,其中的信息可能已经有所发展或是发生改变。

    最近计划开源一个项目,功能很简单总共就 3 个命令加一些扩展,结果文档写了两个月还是不满意,删了写写了删。真的比写代码还纠结

    16 条回复    2020-09-04 19:59:58 +08:00
    wysnylc
        1
    wysnylc  
       2020-09-04 16:56:09 +08:00
    文字的历史比代码可久多了
    rimutuyuan
        2
    rimutuyuan  
       2020-09-04 16:57:12 +08:00
    写文档还好,写解决方案才费劲,想起了被 800 字支配的恐惧
    redbuck
        3
    redbuck  
       2020-09-04 17:02:42 +08:00
    找下有没有自动生成的方案.
    iMiata
        4
    iMiata  
       2020-09-04 17:05:40 +08:00
    上家公司基本所有项目的文档基本都是我给补齐的,亲身体会是写文档用英文比中文简单
    heboy
        5
    heboy  
    OP
       2020-09-04 17:07:06 +08:00
    @iMiata 哈哈我也觉得,英文的反而好写,可能是我英文词汇量少不用纠结
    shifttacn
        6
    shifttacn  
       2020-09-04 17:10:28 +08:00
    工作内容一大部分是看别人的代码,然后写文档。
    看别人代码才是最难的。
    iMiata
        7
    iMiata  
       2020-09-04 17:10:42 +08:00
    其实主要是编程整个一套知识体系都是舶来品,用英文描述相对比中文更准确(也是水平还不够,没法用中文准确描述哈哈)
    raaaaaar
        8
    raaaaaar  
       2020-09-04 17:11:34 +08:00 via Android
    看什么文档吧,复杂点的程序,如果文档没写好,程序质量也不会太高。
    wangkun025
        9
    wangkun025  
       2020-09-04 17:28:33 +08:00
    代码也是英文的,所以……
    iConnect
        10
    iConnect  
       2020-09-04 17:40:10 +08:00 via Android
    有些复杂度高的代码,100 行不到,半天看不明白也很常见
    IGJacklove
        11
    IGJacklove  
       2020-09-04 17:43:27 +08:00 via Android
    文档先写个大概的被,有问题可以等别人 pr 或根据具体问题补充
    cassyfar
        12
    cassyfar  
       2020-09-04 17:43:48 +08:00
    一个好的代码,不需要文档,因为他有自述性(狗头
    hoyixi
        13
    hoyixi  
       2020-09-04 17:58:46 +08:00
    你这是使用文档吧,设计文档更显技术,好的设计文档,放在那里,拉几个人立刻就能重新做出来
    heboy
        14
    heboy  
    OP
       2020-09-04 18:25:41 +08:00
    @hoyixi 没错,是使用文档😅
    wzzzx
        15
    wzzzx  
       2020-09-04 19:29:14 +08:00
    我也觉得文档难写,说人话是真的好难
    Cielsky
        16
    Cielsky  
       2020-09-04 19:59:58 +08:00
    @wzzzx 说人话确实难哈哈
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1152 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 18:51 · PVG 02:51 · LAX 10:51 · JFK 13:51
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.