关于文档 :: 技术点滴

来源: BlogBus 原始链接: http://www.blogbus.com:80/blogbus/blog/diary.php?diaryid=138481 存档链接: https://web.archive.org/web/20041031061311id_/http://www.blogbus.com:80/blogbus/blog/diary.php?diaryid=138481

技术点滴 几年的软件研发做下来，接触的技术，零零碎碎加起来，居然手指不够数了。不少东西，是帮工程部门解决完就扔一旁。弃之可惜，何不借这网络一角，留下一点记忆？遂有此Blog。 <<<看了一下上次提到的DENG | 主页 | GMail里的邮件能否永久删除>>> 关于文档 2004-04-13 某项技术，同事已经做过研究，我现在要大致了解一下以放到总体设计里去，于是就去找他的文档。没有，一点文档也没有，只有一堆实例程序的代码。差点就想抓狂。用了那么长一段时间去做研究，结果连个文档都没有，居然也能算完成任务？这样如何实现技术的快速交流与传递？ 我在带一个小组的时候，最强调就是每项技术学习的任务都要出文档。不是100%原创也无所谓，就算是拿别人写好的东西充数，只要你去做文档，那就或多或少会把自己的心得体现出来――哪怕是只是外部文档的阅读次序、英文文档的摘要，都是对后来者有意义的。 其实在技术研发里，尤其在学习新技术时，做文档是很好的整理思路的机会。光是章节间的编排，就能逼着你去捉摸该项技术的重点在哪里，前后的逻辑是什么。我自己的经验，刚要开始写的时候会觉得很痛苦，但写完了就会觉得是真正掌握了该项技术。 常见的不肯写总结文档的两个理由是：1、写了没用，没人看；2、没时间写。不是说没有这两种情况存在，但都不能作为正当的理由。对于前者，不是没人看，而是不知什么时候会被用到。作为一项“工作行为”，不能以此为理由来推卸自己在技术积累方面的责任。对于后者，如果我是任务布置者，那我一定会说：没关系，我给你时间。 ――牢骚发完，需要的文档还是没有，再找别的途径吧，叹气:( linrun 发表于 2004-04-13 15:29 引用Trackback(0) | 编辑 Comments 发表评论 最近更新 我还活着 tomcat mysql 连接池 配置 中文 Commons Logging + Log4j快速入门 最近Blogbus很不稳定 London Bloggers 新分类Java basic 换模板了 fy GMail tips Google Logo For The Athens 2004 Olympic Games 淘到一个“拼接式自我资产分析图” 逝者如斯 反向链接 访问统计 DVD Movies