级别: 初级 Steven Aoki (saoki@us.ibm.com), Content Management User Technology 小组成员, IBM Corporation Darryl Bloch (dbbloch@us.ibm.com), DB2 Content Manager OnDemand User Technology 项目经理, IBM Corporation Stacia Sambar (stacias@us.ibm.com), DB2 Content Manager OnDemand 技术作家, IBM Corporation
2004 年 9 月 01 日 通过传统的硬拷贝文档查找与产品有关的信息,常常因为可查找性和可检索性问题的干扰,而成为一项难以完成的任务。Information Center 的引入带来了一些显著的好处,本文介绍的是 IBM® DB2® Content Manager OnDemand 产品的信息中心。
简介
向用户提供高质量文档面临的一个最大挑战是可检索性问题。用户可能需要执行某些基本的系统任务,比如安装新的组件、配置已有应用程序、查看错误消息等。在理想情况下,这类信息应该很容易检索和应用,但实现这个目标需要克服几方面的障碍。
第一个障碍是用户文档库的完整性。如果缺少了基本的参考资料,用户无法执行所需的任务。第二个障碍是信息的及时性。如果用户文档已经过期(比如基于上一版本的参考书),那么用户就无法找到需要的信息。
另一种障碍是可查找性。即使用户拥有完整的产品库,使用传统的用户文档模型找到目标信息可能也非常困难,比如查找某个示例代码片段或者错误消息,传统文档模型将信息划分成一些离散的资源,如
用户指南和
安装和配置手册等。在最终找到这些关键的信息之前,用户可能需要查看不同手册的很多索引和正文。
产品文档的一次重大改进
通过与用户交谈和走访客户,IBM 了解到,像 DB2 Content Manager OnDemand Information Center (IC) 这样的信息资料库,可以极大改进用户查找和应用所需技术帮助的过程。IC 代表了编译、组织和向用户传播重要信息的全新方法,与传统的信息分发方法相比,它具有显著的优势:
-
完整性:OnDemand IC 是产品基本信息的一个方便、集中的存放场所,是满足用户信息需求的一站式服务工具。您只需要敲几个键,就能够得到所有需要的、最新的用户信息,OnDemand IC 甚至允许跨一个或多个产品库查找信息。
-
标准化:OnDemand IC 标准化了 IBM 向用户提供产品信息的方式。作为提供开放源代码技术和标准化软件文档提交方式的 IBM 公司战略的一部分,OnDemand IC 采用了 Eclipse 技术。它采用了统一的 Web 浏览器界面,向客户提供需要的产品文档。
-
可移植性:如果用户远离工作环境但仍然需要某些重要的信息, OnDemand IC 提供了可移植性,但这种可移植性不是通过硬拷贝文档来实现的。OnDemand IC 可以在本地运行、在光盘上运行、在内部网服务器上运行,而且还可以在 IBM Web 站点上运行。 OnDemand IC 的各种安装选项可以确保用户随时随地根据需要访问产品文档,无论是在安全的实验室环境中、企业内部,还是在旅途中。
-
可定制:OnDemand IC 用户可以为关心的页面或者常用参考插入书签,以便将来能够方便查找这些有用的信息。这种特性只能用于独立客户模式。
用户希望能够查看和寻找整个产品库中的信息,而不想在不同的信息资源间来回切换。对于所有的用户,尤其是新的用户,面对像 OnDemand 库这样大的产品库,查找信息可能是很难的。比如,用户可能错误地在
Installation and Configuration Guide而不是
Web Enablement Kit Implementation Guide中查找安装 OnDemand Web Enablement Kit 的帮助信息。在信息中心中,用户可以输入关键字,然后系统使用该关键字搜索整个产品库。如果有多个产品库分布在同一个信息中心中,那么用户可以选择一个或多个库来进行搜索,缩小或者放宽搜索的范围。
OnDemand Information Center 揭密
信息中心技术
Eclipse 信息中心基于 Java™ 运行,并且在 Web 浏览器中显示其界面。该界面中采用了以下开放源代码技术:
- Tomcat Web 服务器。
- Xerces。
- Lucene 搜索引擎。
信息中心支持的模式
用户可以用 4 种不同的模式启动和关闭 Eclipse 信息中心:
-
Web 服务器模式:作为 Web 应用程序服务器(使用 Tomcat)启动和关闭信息中心,允许其他机器通过静态的端口(如 http://hostname:port)访问信息中心。
-
本地独立客户模式:作为独立的客户程序启动和关闭信息中心,在随机生成的端口上自动打开 Web 浏览器来查看文档。该模式允许使用书签和保存搜索过滤器。
-
CD-ROM 模式:在光盘上启动和关闭信息中心。当从只读的 CD-ROM 上启动时, Eclipse 系统将框架临时保存在一个本地临时目录中。
-
Internet 模式:可以通过任何 Web 浏览器访问以下 URI:
http://publib.boulder.ibm.com/infocenter/cmodhelp/index.jsp。
导航面板
导航面板使用 Eclipse XML DTD 在一个可展开/折叠的层次结构中显示主题。Eclipse 动态地从 Eclipse “plugins”文件夹中的“文档插件”中读入主题。
其实,
文档插件就是包含 HTML 内容库的目录。通常,它显示为导航面板中的一个“书本”节点,不过很容易更改导航,以显示不同插件中的不同主题。
其实,文档插件包含压缩的 HTML 和 GIF 文件(也可以包含其他格式,如 PDF)、XML导航文件、压缩的预索引文件(可选)和每种文件的翻译版本。可以将数百个 HTML 文件保存到一个 doc.zip 文件中,这对性能只有很小的影响。
文档插件也可分为不同的版本,您可以将版本附加到目录名后(Eclipse 自动读取最新的版本),这样,升级后的文档插件就会先于原来的文档插件显示,因此也就不需要删除原来的版本。因为 Eclipse 是动态读入文档插件的,所以安装程序可以随时添加新的文档插件。重新启动 Eclipse 之后,它会修改导航面板并检索索引,读入新的文档插件。
搜索引擎
Lucene 搜索引擎支持所有民族的语言和 Unicode (UTF-8)。 它可以突出显示页面中的每一个词,包括完整的短语(使用引号)和不同的时态。该搜索还允许进行 Boolean 查询和结果筛选。
在 OnDemand IC 的第一次搜索中, Lucene 搜索引擎运行一个预索引程序,缓冲搜索结果列表,从而使后续的搜索几乎瞬间即可完成。也可以提前运行命令对搜索进行预索引。当添加或删除文档插件时, Lucene 会刷新搜索索引来适应变化。此外,用户也可以通过删除
\workspace 目录来删除搜索索引,这样,下一次搜索时就需要重新运行预索引程序。
民族语言
翻译文档可以和英语文档放在同一个文档插件中。Eclipse 可以使用 Web 浏览器当前设定的语言来显示文档。如果全部或部分文件没有翻译,那么 Eclpise 会在运行时自动代之以英语文件。
丰富用户的经验
OnDemand IC 通过以下几个方面丰富了用户查看和搜索文档的经验。
- 将所需要的信息综合成一站式商店。
- 可以搜索不同的库来检索所需要的信息。
- 在独立客户模式中标记感兴趣的页面。
一站式商店:在一个地方找到所有信息
OnDemand IC 可以用任何翻译语言显示支持的产品库中的任何文档。目前, OnDemand IC 包含以下文档:
- OnDemand for Multiplatforms Version 7.1.1 的全部文档。
- OnDemand for z/OS® 和 OS/390® Version 7.1 SPE2 的全部文档。
- OnDemand for iSeries™ V5R3 文档。
- 管理客户在线帮助。
不需要将搜索限制于特定的书籍或者语言,用户现在可以使用导航和搜索引擎更方便地查找信息。
强大的搜索功能:检索需要的信息
OnDemand IC 拥有强大的搜索功能,用户只需要在
Search字段中输入关键字,就可以找到需要的信息。信息中心对整个文档库进行搜索。也可限制它只对 IC 中的某些特定部分进行搜索,比如用户可以要求信息中心只搜索 OnDemand for Multiplatforms V7.1.1 库。
应用场景
该例中,用户希望了解如何在 Windows 上安装 DB2 Content Manager OnDemand for Multiplatforms Version 7.1.1。
用户可以用两种方法在 OnDemand 信息中心找到这篇文档:
方法 1:使用信息中心导航面板
启动信息中心后,单击
OnDemand for Multiplatforms 7.1.1 --> Installation and Configuration Guide --> Installing OnDemand on Windows® 服务器。主题显示在右窗格中。
方法 2:使用搜索
启动信息中心之后,在 search 字段中输入
install OnDemand on Windows
。
引擎在整个库中搜索安装 OnDemand on Windows 服务器的信息,然后在左窗格的“Search Results”下显示搜索结果。第一行应该是“100% OD MP Install - Installing OnDemand on Windows server”。单击该搜索结果,主题就会显示在右窗格中,并且文中所有关键字都以高亮显示。
如何获得 OnDemand Information Center
有两种获得 OnDemand for Multiplatforms Version 7.1.1 Information Center 的方法:访问 www.ibm.com 上的在线版本,或者从工作站或内网中下载并安装该版本的副本。
结束语
OnDemand IC 代表了用户与必需的产品文献进行交互的方式的重大改进。IC 的优势表现为:跨多种产品库的可搜索性、可移植性(可使用任何 Web 浏览器访问)、信息的准确性和及时性、使用开放源代码技术的标准化软件文档提交方式、NLS 无缝支持,以及满足用户全部需要的一站式服务。
参考资料
作者简介  | 
|  | Steven Aoki 领导着 Content Management User Technology 小组的 Information Center 团队,同时还是位于 San Jose, CA 的 IBM 硅谷实验室的技术作家。 |
 | 
|  | Darryl Bloch 是位于 San Jose, CA 的 IBM 硅谷实验室 DB2 Content Manager OnDemand User Technology 小组的项目经理和技术作家,定居在 Research Triangle Park, N.C。 |
 | 
|  | Stacia Sambar 是位于 San Jose, CA 的 IBM 硅谷实验室 DB2 Content Manager OnDemand User Technology 小组的技术作家。 |
对本文的评价
|