编写有效的联机帮助

我认为对于软件产品来说，最难的是联机帮助，或者更准确地说，是缺少帮助。我所说的这个问题是，大多数联机帮助对我们根本没有任何帮助。在我的理想世界中，我应该点击 Help 图标然后得到自己想要的答案。相反，我曾经遇到过一个非常复杂的应用程序，我花了很多时间来学习如何导航――只是为了找到我的答案，这些答案七零八乱，分散在不同子标题下独立的联机图书中。

下面是一些有关联机帮助的抱怨：

? 没有索引或搜索功能。

? 界面很混乱（比如说你不知道该在哪里点击，或者不知道如何去搜索）。

? 信息流非常奇怪（也就是主题跳跃非常大）。

? 帮助非标准化（也就是，内容和表现不一致）。

? 帮助非常复杂（也就是要花很长时间才能找到帮助特性）。

? 帮助太分散（也就是你必须导航到几个位置才能找到你想要的答案）。

? 太冗长（软件文档应该简明准确）。

? 内容太多。

虽然这个列表并不很详细，但是却道出了问题的多样性。行业标准可能有帮助，但是供应商之间的竞争看上去似乎扩大了这一问题。比如说，在帮助中放置一些图表可能会使得软件比你显得更加聪明。我花好几个小时来编辑我的专栏，目的只是让我的文字处理器更改我的语法，或者重新设置不同单词的大小写。

开发能用的联机帮助可能解决前面提到的很多问题。帮助的作者不应该将使用他们编写其它文档的方式来编写联机帮助。首先，联机帮助实际上是一个应用程序。因此，他们必须考虑如何访问和组织信息。在书面文档中，在书籍的最后通常会有一个按主题分类的字母序索引。虽然联机帮助也要求这一点，但是字母序索引只是几种可能的访问方法之一。其它的方法包括关注内容的帮助、相关链接以及搜索功能等。很多有效的帮助系统都提供了所有这些功能。

主题组织是另一个成功的关键。联机帮助应该尽可能快地提供用户请求的信息，同时还是尽量减少用户为解决问题所需的阅读量。要达到这一目标，帮助的作者应该以一种一致的方式组织主题材料。这里有一个技巧，那就是按照从重要到次要的顺序组织材料。另外一个技巧是将那些最有可能回答常见问题的答案放在最前面。不管使用哪种方法，帮助内容不应该试图回答所有问题，如果想要更详细的信息，应该参考联机手册。这样就减少了混乱，使帮助材料更加容易导航。

帮助内容还应该具体针对那些与主题材料链接的内容相关的主题。帮助信息通常试图一次回答太多相关问题。相反，应该考虑软件的使用方式并以同样的逻辑回答用户的问题。

在帮助系统中，整个文档的表现也应该一致。必须使用标准的图标、链接、标题、索引以及主题内容。视觉混乱与内容混乱一样让人丧气，所以导航和图标应该组织地清晰一致。

最后，还要细心地选择内容作者然后再进行编辑。


--------------------------------------------------------------------------------
Scott Withrow 有20年的 IT 工作经验，其经验包括IT管理、Web开发管理和内部顾问应用分析。