• 2006-04-06

    拿成果来

    版权声明:转载时请以超链接形式标明文章原始出处和作者信息及本声明
    http://www.blogbus.com/dreamhead-logs/2241422.html

    相信许多程序员和我一样,对代码的感情远远胜过文档。因为除去编译器的自动化工作,代码就是我们的最终产品,而且代码中饱含着我们的智慧,文档?那只是用来浪费时间和应付差事的东西。至少有相当长的一段时间,我是这么想的,这可能与我原来所在部门对文档没有给予足够重视的结果吧!

    我很清楚文档的意义,写作可以帮助理清思路,给后来者一个参考等等,但是,文档给我的感觉更多的是一种不得不做的事情,所以,让人很难提起精神。

    现在和我一同工作的一个博士,他来自公司软件过程做得最好的部门。他做事的一个习惯就是一定要有成果物,而文档就是成果物一种很重要的形式。或许,他是同我一起工作过的人中最愿意写文档的一个。不论是做调研,还是做设计,到最后,他保证会拿出一个质量相当高的文档。每每说起这些文档时,他总是说,以后翻起来,一看自己写了这么多文档,那也是一种成就感。他对文档的态度潜移默化地影响着我。

    编写代码带给我们的是一种成就感,难道文档就不是吗?同样的工作,干嘛要有分个高低贵贱呢!人的惰性会驱使我们不去做一些事情,但我们却愿意享受成果,其实差别只在于一个态度。就像写blog,不愿意写文档的我却很愿意写blog,因为这个过程可以带给我一些愉悦,就这样,我不知不觉坚持两年有余,偶尔,我会翻看一下自己之前写的一些blog,享受一下已完成的快乐。如果是在重压之下完成这些blog,我保证坚持不了几天,就断了继续写下去的念头。对文档,何尝不是如此?最近正在做一个调研,读过一些资料顺手做了一些笔记,几天下来,一个文档便已初具雏形了,自我感觉良好。

    有时我做事往往会跟着感觉走,做过一些工作无疾而终。做事应该有个可以衡量的成果物,不仅仅是文档。当回首成果物时,既可以告诉别人自己已经做的工作,也可以为自己做一些精神上的安慰疗法。当然对于程序员来说,在开发过程中,源码是一种不可或缺的成果物,但我们可以做得更多。

    分享到:

    历史上的今天:

    别在花开时 2005-04-06
    朋友和敌人 2004-04-06
    引用地址:

    评论

  • 不知道你玩python不。我想python对这方面的支持做得很好

    python里面伴随代码的文档 编写起来非常自然 查看起来更方便。还有doctest 的东东 。

    当然 需求分析 设计报告这样的文档除外
    回复huangyi说:
    我用python写过一些程序,类似的,Java也支持在代码中编写doc,但这和我在blog中提到的做事用成果并不完全一致。
    2006-04-22 13:03:35