| 开发系统成败的关键就是文档－IBM |
| 作者:梦翔儿 日期:2007-7-11 18:42:00 |
今天在IBM的技术网站上看到这样一句话，觉得很有体会，说地很好：
不管选择开源还是闭源的形式，开发系统成败的关键就是文档。文档是很多开发工作都不希望要的内容；开发人员通常都会专注于代码的编写，而不是对现有代码的解释。因此这个问题就被进一步放大了；缺少文档的代码往往会被按照更难以编写文档或难以理解的方式进行修改。
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
想想来看，文档在软件开发过程中的确是很重要的，正好和最近研究的东西有些关联，深入看下去：
Second Life 团队为文档维护了一个公共的 wiki。这个项目尽管尚不完整（所有的文档都不是完整的），但是正在积极进行维护和更新。wiki 为所使用的脚本语言和 C++ 源代码的架构编制了文档。为脚本语言（LSL）很好地编制了文档，不过有些部分尚不完整。举例来说， Communications 分类列出了 3 个子类：Chat、HTTP 和 XML-RPC。只有 Chat 类已经完成了。通常，如果 wiki 页面上的链接是红色的，就说明相应的资料还没有编写。这种链接被用作占位符，说明此处的内容将要被编写为文档。 对于任何产品来说，文档不完整都不罕见。我曾经见过很多商业手册中有一两页这样的内容：“Gzornenplatz setting (Enabled/Disabled): Enable or disable gzornenplatz”。其中根本没有任何提示说明 gzornenplatz 是什么，或者启用它会造成什么影响。使 Second Life 文档非常有趣并且使其非常适合查看器开源版本的一个原因是这个 wiki 是可以由用户进行编辑的，并且鼓励用户对此做出贡献。尽管在开源项目中这并不稀奇，但是在商业项目中却非常罕见。更不寻常的是它使用 wiki 作为主要文档；它们通常用来作为补充资料。这样做有一些优点，也有一些缺点；已经提供了更加完整的文档固然更好，但是能够编辑文档就意味着可以很快解决问题。如果现在还不是一件好事，那么几个月之内就变成好事了。
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
这几天和学生在一起调了一下php的Viki，忽然发现，原来Web2.0真地已经在眼前了，有太多的新东西，需要我们去学习，去研究。今天坐班车上，教务处的一个老师还和我谈博客的使用，准备在学校教师中建立一个博客系统，让更多的大学教师接受这种新的形式。Web2.0中有很多新的理念，容易理解，但编程实现又是那么的具有挑战。但我喜欢这种新奇的挑战，却又担心自已的落后，看来草根的精神，离我们很近了。 |
- 上一篇：WSE 股 市 初 探
- 下一篇：他们在做什么——进入SL的跨国企业们
| Re:开发系统成败的关键就是文档－IBM |
| 作者:zzr(游客) 日期:2007-7-14 15:10:54 |
 系统开发就像在海上航行，文档就好像是航行过程中的导航体系，要达到目的地，就要用导航体系确定一条最短的航线。缺乏指引的船只最容易在海上迷航，缺乏文档的开发过程也最容易失去控制。系统开发又像是一个走迷宫的过程。要走出一个没有完全了解的迷宫，就要不断的试探和折返，折返就是要回到每一次试探前的起点上去。在试探的路上撒上面包屑，可以帮助我们找到回去的路，这样我们就可以避免兜圈子，从而尽快走出迷宫；系统开发在某种角度上看是一个不断试探和改进的过程，文档就像撒在试探路上的面包屑，保证我们不会在原地兜圈子。当你走出迷宫的时候，回头看看走过的路，大部分时间都是花在了折返的路上不是前进的路上，难道就没有办法不折返吗？随着你走这个类型的迷宫越来越多，折返的时间可能越来越少，但迷宫总是在变化，因此折返在总的过程总是要占很长的时间的，软件开发也是如此，修改的过程远比系统添加新功能用的时间多。 |
| Re:开发系统成败的关键就是文档－IBM |
| 作者:隋阳(游客) 日期:2007-7-11 19:21:00 |
| 确实，开发文档非常重要，项目越大，文档的重要性就越明显，我手里的项目已经作了快半年了，如果没有文档，有一些细节的地方，自己都忘记了。 |
| Re:开发系统成败的关键就是文档－IBM |
| 作者:zerox(游客) 日期:2007-7-11 18:56:52 |
| 现在还看不懂~ 还需要学习 |
站点公告