Wiki 文档运动
随便问问别人,他们都会告诉你我是一个老顽固,简简单单的那种。我每次都更喜欢纸和笔而不是电子和液晶显示器,而且我不喜欢为了技术而技术。我也不喜欢糟糕的文档。我们都知道那种文档。那种文档会说启动 widget master…,然后它不会告诉你,要启动 widget master,你实际上必须启动一个名为 backwards engine 或类似名称的不同程序。Oracle 就以那种伎俩而闻名。还有那种无用的文档,那种文档会说如果您仍然有问题,请联系您的管理员。我们来自 Redmond 的朋友们已经从我这里听到了很多关于这个的抱怨。
回到黑暗时代,我发现了一个很棒的程序,叫做 faq-o-matic。这个基于网络的工具是 Wiki 运动的前沿。它是一个简单易用、可扩展、可索引且易于使用的 FAQ 工具。我出于个人原因部署了它——我想要一个地方来记录当时我正在构建的各种系统的笔记,基本上是我自己一个人,而且除了代码附带的 README 文件之外,没有太多支持文档。即使是那些文档也很单薄。我是在摸着石头过河,需要一种方式来提醒自己我做了什么,即使没有其他人。唯一的major drawback是打印功能。当时,它非常有限,但通常我们不会从中打印太多内容。我们的大部分打印文档都是某种文档或 PDF 文件。
快进到今天。文档编制已经取得了巨大的进步,大部分情况下是这样。糟糕的文档仍然存在,但它变得越来越罕见。我最常在尝试阅读从不以英语为母语的开发人员或开发团队翻译成英文的文档时发现它——我在日本制造的无线电设备中经常发现这种情况。无线电设备越技术性,文档就越难理解,尽管说明书是用英语写的……或者至少看起来像英语的东西。但真正兴起的是 Wiki 形式的文档。这有其优点和缺点。
优点是显而易见的。它易于更新和编辑,使其保持最新,尤其是在快速发展的开发环境中。安装团队或最终用户提交的评论可以轻松纠正错误。它是一个活文档。
缺点,而且这一点不太明显,是它几乎不可能把这该死的东西打印出来。还记得关于我是老顽固的评论吗?我更喜欢在纸上阅读我的文档。我年纪大了,视力不太好,尤其是我必须浏览数百页的时候。此外,我倾向于在页边空白处做笔记:需要注意的事情、需要意识到的事情、需要检查的事情以及稍后要追求的想法。所有这些事情都非常有用,但所有这些事情都很难用在线文档来完成。我还发现我利用通勤时间进行阅读,而我的通勤路线穿过一大片蜂窝信号盲区,即使我的笔记本电脑有宽带卡,也对我没什么用处(这也是我不使用宽带卡的原因之一)。
我发现在线文档的另一个问题是,我最常在无法以电子方式获取文档的情况下需要文档。我在一个无法访问浏览器或受到文档站点过滤访问的服务器机房里。还有一个实际问题是缺乏屏幕空间来阅读文档和执行命令(这比你想象的更常见,尤其是在你所在的行业只为每个系统分配一台显示器的情况下,因为为什么会有人需要不止一台显示器?)。
并不是我反对基于 Wiki 的文档。在很大程度上,我喜欢它。但是需要有一种方法将文档提取到一些易于打印的形式中。通过单击打印、下一步、打印、下一步来逐页打印不是一个好的时间利用方式。缩放和框架使情况更加复杂(而且当我打印一页却发现我没有得到文档而是外面的框架时,我真的很沮丧!)。我知道这是可能的,并且在许多情况下相当容易。
因此,如果您是文档生产者,请记住,有很多人想要使用您的文档。他们如何使用它与文档中的内容同样重要!