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

每次写完程序有没有必要写类似 wiki 的文档做记录???

  •  
  •   thinkdeep · 2017-10-16 00:29:12 +08:00 via iPad · 5243 次点击
    这是一个创建于 2356 天前的主题,其中的信息可能已经有所发展或是发生改变。

    公司要求每个程序员做过一些东西都要写类似于 wiki 的文档做记录, 感觉非常没必要各位如何看,是不是很多公司都是这么做的。

    9 条回复    2017-10-18 01:35:00 +08:00
    zhique
        1
    zhique  
       2017-10-16 04:15:09 +08:00
    除了代码外,你不留下点领导看得懂的干了活的证据,怎么让领导给你升职?
    willakira
        2
    willakira  
       2017-10-16 09:24:53 +08:00   ❤️ 1
    感觉非常有必要,通过类似于 wiki 的记录,你可以
    - 作为这个组的新成员,可以知道怎么设置环境,本组的大致架构是什么样子的
    - 作为其他组的成员,你可以知道这个组做的是什么事情,有事情的话找谁,如果要整合的话双方的技术实现有什么差异
    - 某些会议的记录等等
    毕竟好记性抵不过烂笔头
    组织小的时候就要养成这样的习惯,以后组织大了再搞这些成本太高了
    tonghuashuai
        3
    tonghuashuai  
       2017-10-16 10:58:43 +08:00
    如果你中途接手过几个项目,并且联系不上前项目成员了,那么你就会想:为什么他们没有留文档!!!
    wuyuchenshishabi
        4
    wuyuchenshishabi  
       2017-10-16 11:32:14 +08:00
    LZ 是刚工作的吧。很多外企都有专门的文档工程师。你该不会觉得鬼佬傻吧?
    PythonAnswer
        5
    PythonAnswer  
       2017-10-16 14:57:07 +08:00
    注释 文档 测试...
    noNOno
        6
    noNOno  
       2017-10-16 15:12:37 +08:00
    有,不然交接就痛苦了
    最讨厌的事:1 自己要写文档.2 别人不写文档
    lap510200
        7
    lap510200  
       2017-10-16 16:27:02 +08:00
    非常有必要,虽然特别不想写
    thinkdeep
        8
    thinkdeep  
    OP
       2017-10-18 01:30:17 +08:00 via iPad
    怎么可能刚毕业,以前公司都不会过多记录,代码规范就行,程序员应该很少写这些东西
    thinkdeep
        9
    thinkdeep  
    OP
       2017-10-18 01:35:00 +08:00 via iPad
    总觉得重要的记录下,不然程序员就成为写文档的了,国外之所以有专门写文档的,可见程序员很少写,也不喜欢写,
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1012 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 19:27 · PVG 03:27 · LAX 12:27 · JFK 15:27
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.