使用定制Eclipse信息中心为IT解决方案编制文档,第1部分

第 1 部分: 创建您的第一个信息中心

概述

实现 IT 解决方案的过程涉及集成并定制各种软硬件组件。要针对已实现的解决方案整理一份 “维护指南”,相关的文档和其他技术信息可能涉及多个作者、文档位置和文档格式 — 范围涉及传统的 teamrooms 和官方文档、论坛、博客和 wiki。收集、整理并向您的客户(或老板、团队)交付这些文档需要付出大量的劳动,如果您不擅长此类任务的话,则更是一项费力的工作。另一种选择就是提供不够充分的文档,而它的缺点就是增加了支持成本、不能有效利用生产力,并且客户信息大打折扣。

本文将介绍一个工具箱,它可以帮助个人或项目团队快速完成为 IT 解决方案编制文档的任务。如果您以前经常通过记录链接列表或整理有用文档的 ZIP 文件来对 IT 解决方案进行编制文档,那么考虑花相同的时间来构建一个解决方案信息中心,它将逐步增长,直到完成解决方案的生命周期,并并入 RSS 提要之类的技术来保持信息的时效性。

此工具箱封装了设计、架构并将信息交付到模板和自动化例程的最佳实践,这意味着它不需要用户体验、信息开发或 Eclipse 插件编码方面的技能。该工具箱在 Eclipse 的富客户机平台上实现,并生成标准的 Eclipse 文档插件,但是您不必安装 toolkit 集成开发环境就可以使用该工具箱。

结果:定制的信息中心

为客户提供了一个可移植的自包含的信息中心,可以在本地或远程桌面,在 Intranet 或 Internet 上访问。如图 1 所示,信息中心导航、主页和浏览器标题可以针对特定的解决方案定制。

图 1. Project Zero WebSphere sMash 技能包

如果交付解决方案信息中心和用于创建它的项目,那么接收者可以在整个解决方案生命周期内通过更多文档对信息中心进行扩展。用于开发和更新定制解决方案信息中心的工具箱可以从 IBM® alphaWorks 免费获得。

方法:具有易于使用的图形用户界面的工具箱

来自 alphaWorks 的 Toolkit for Custom and Reusable Solution 帮助您构建一个信息中心,从而实现客户交付或团队成员共享。启动解决方案信息项目后将显示一个图形导航树,您可以在其中拖拽信息,比如演示文件。您很快就会拥有组成面向任务的解决方案信息中心的组件,并且不需要信息开发或用户体验技能。您可以为客户导出一个自包含的信息中心,从而在桌面、Intranet 或 Internet 之上运行。

该工具箱使您能够完成以下任务:

跟踪初始的和重用的信息以为 IT 解决方案编制文档

搜索在线内容并捕捉内容以实现重用

累积您的个人内容库:方便的链接、提要、查询和文档

通过导入和导出内容,与他人共享内容库

重用各种定制信息中心中的内容

将信息聚合到经过良好组织的解决方案信息中心

将内容组织到一个最佳导航模板

为团队创建并共享导航视图模板

针对特定的受众定制解决方案信息中心,比如客户

将一个统一的外观(facade)应用到一组报告、演示和其他信息之上

轻松、重复地预览定制信息中心

将定制的解决方案信息中心交付给客户和其他受众

导出 ZIPs 以交付给客户

在桌面上运行信息中心,支持其他人进行远程浏览

在 Intranet 上托管远程中心

导出解决方案信息中心,使其他人能够重用并扩展它们

技术:基于 Eclipse 的帮助系统

Eclipse Platform. 提供了自己的基于 XML 内容表的帮助系统,这些表引用了 HTML 文件,如 使用 Eclipse 帮助系统为项目编制文档 — 构建易于使用且可搜索的帮助文档 所述。帮助系统不需要作为软件用户界面的一部分集成。事实上,帮助系统可以独立运行。它可以实现一次交付,然后可以在桌面和 Intranet 或 Internet 托管之间轻松地切换。这些特性使得 Eclipse 帮助系统成为一种方便的工具,可以交付完全自包含的、自给自足的文档站点(称为信息中心)。

Toolkit for Custom and Reusable Solution Information 使得强大的基于 Eclipse 的信息交付系统进一步可供每一个人使用,即使您不是软件开发人员或信息 Web 站点开发人员。它提供了一个图形式拖拽界面,使您能够生成包含您自己的内容的基于 Eclipse 的信息中心,并且不需要掌握任何有关 Eclipse 插件打包约定的知识。

启动定制解决方案信息中心

准备好创建您的第一个信息中心了吗? 首先,从 alphaWorks 获得并安装 Toolkit for Custom and Reusable Solution Information。该工具箱被打包为一个 ZIP 文件。工具箱的安装非常简单,只需解压缩 ZIP 文件的内容。接下来,打开工具箱并找到工作空间,可以在工作空间中启动一个解决方案信息项目。

要启动一个解决方案信息项目:

双击 run.bat 文件,启动工具箱图形界面。

图 2. 双击 run.bat 以启动工具箱

当工具箱欢迎屏幕出现后,单击 Workbench 按钮,如图 3 所示。注意,其他按钮提供了阅读概览、查找教程等功能。

图 3. 欢迎屏幕,其中选择了 Workbench 按钮

启动一个与解决方案信息中心相对应的项目。

从菜单中选择

File > New > Solution

信息项目。一个新的解决方案信息项目对话框将显示出来。

指定一个项目名,例如 “Cloud computing solution for J.K. Enterprises”。

单击Finish。

一个导航视图面板将显示出来,可以进行定制并填充内容。

为您的信息中心定制导航视图

默认的导航视图模板以一种全面的、经过良好组织的方式封装了用于为 IT 解决方案编制文档的最佳实践。然而,如图 1 的解决方案信息中心所示,您可以根据自己的需求修改默认的导航视图。鉴于稍后将讨论的几个原因,建议您不要删除默认导航视图中的区段,随着解决方案在整个生命周期中的演变,这些区段可能需要在几天、几个月或几年之后应用到您的解决方案。

要针对特定项目定制导航视图模板的显示:

选择导航模板的一个区段(黄色的方框),比如 “My solution”。它将变为浅黄色。

双击条目,激活对条目标签的编辑操作。

修改标签显示,比如 “Cloud computing solution for J.K. Enterprises”。(当编辑导航视图时,导航条目的开始部分将显示数字 0,但是将不会在您的解决方案信息中心中显示)。

要保存对当前导航条目作出的修改,选择一个不同的导航条目即可。

图 4. 定制导航视图

尝试拖拽导航区段,以重新组织导航视图。还可以添加或删除导航区段。当右键单击时将显示一个菜单,从而提供了一种方便的方法来定制导航视图。

收集希望包含的内容

考虑您希望收集并以集成方式在单个导航视图中呈现的原始和重用内容。识别文件,比如样例、多媒体和办公文档。考虑其中包含有要捕捉的内容的内部或外部 Web 站点或 wiki,或者 IBM Lotus Notes® 数据库。

工具箱支持的内容的类型

文件:

本地文档,例如报告,电子表格,演示和代码样例。

Web 内容:

Web 页面,可以是链接,也可以是使用工具箱生成的本地副本。

提要:

RSS 和 ATOM 提要,帮助您的用户查找最新的内容。

Notes:

从 Lotus Notes 团队空间导出的文档,或 Notes web 界面中的文档链接。

图书:

Eclipse 文档插件,是可重用的打包单元,可以被信息中心理解。

在第一次将文档或 Web 页面告知工具箱后,文档或 Web 页面就可以在多个解决方案信息项目中使用。工具箱支持使用多种方式为您的内容库收集内容:

搜索 IBM.com Web 站点的内容并捕捉内容

导入或导出内容库,以与其他工具箱用户共享

导入 Eclipse 帮助系统插件,这是面向 IBM 产品文档的标准打包方式

导入您以 XL 格式从 Notes 导出的 Lotus Notes 视图

使用配置对话框添加个别文档

首先,使用配置对话框添加来自本地文件系统的文件。

浏览文件(适用于任何文件):

从菜单栏选择Window > Show View > Files。Files 选项卡页面将显示在前台,如图 5 所示。注意,其他选项卡页面用于添加其他类型的内容。

图 5. 添加文件

单击Add Files按钮。

在 Files Wizard 中,将 “default” 设置为组。组功能类似于一组抽屉,其中分类存储了您的内容。

指定一个将在导航中显示的名称,比如 “Cloud computing overview”,如果这可以用来描述您的文件的话。

单击Browse,然后使用浏览对话框定位位于您的文件系统中的文档。

返回到 Files Wizard 后,单击Next。

指定页面信息,该页面将把文件呈现给用户:

指定将在 HTML 页面上显示的标题,这个 HTML 页面由工具箱生成,用于向信息中心的访问者描述您的文件。

指定一个描述,用于帮助用户决定是否浏览该文件。

指定发布者,这是一个可选项。发布者可能是您自己、您的公司、文件的作者,或任何其他合适的值。

指定用于信息中心搜索的关键字。

单击Finish。您会看到文件被列出在 file 选项卡页面中的默认组中。

定制重用文件

在工具箱中捕捉文件后,可以直接在其中编辑文件。在 Files 选项卡页面中定位文件。右键单击文件并选择Edit with…来显示编辑器选项。默认的编辑器通常为 Windows 操作系统中指定的编辑器。当保存文件时,您将保存定制后的版本,以便在任何解决方案信息中心项目中重用。

使用内容填充导航视图

图 5 中的所有选项卡页面组成了您的内容库。可以从内容库中将这些内容(比如一个文件)拖拽到导航视图。

要将文件添加到导航视图:

确保正在查看 Files 选项卡页面。

确保正在默认内容组下查看文件。

在默认内容组中定位文件。

单击文件。将文件拖拽到导航视图,文件在其中将由一个新的导航区段表示。

例如,图 6 展示了名为 Product presentation 的文件在被包含到 Files 选项卡页面以及被拖拽到导航视图后的显示。图 6 还显示了已经填充了多个文件的 “sample project” 组。(顺便提一下,Add Group按钮就在您刚才使用的Add Files按钮旁边的几个按钮处。)

图 6. 向导航视图添加内容

定制浏览器标题和信息中心主页

不管信息中心运行在桌面上,还是运行在 Intranet 或 Internet 上,它都会显示在 Web 浏览器中。信息中心的名称将显示在 Web 浏览器的标题栏。

要对显示在浏览器标题栏中的信息中心的名称进行定制:

从工具箱的菜单中选择Information Center > Browser Title。

指定一个浏览器标题,例如 “Cloud computing solution for J.K. Enterprises”。

单击 Title 选项卡页面中的 “X”,保存您的修改并退出。

信息中心需要显示一个主页来告诉用户有关解决方案的信息。这是用户在查看信息中心时显示的第一个页面。工具箱将根据您提供的信息生成一个主页。

要对信息中心主页进行定制:

从菜单中选择Information Center > Home Page。

指定一个页面标题,例如 “Cloud computing solution for J.K. Enterprises”。

指定各种信息,所有信息都是可选的。

单击 Home Page 选项卡页面上的 “X”,保存您的修改并退出。

图 7. 提供信息以生成主页

图 8 展示了生成的主页,该主页与图 7 提供的信息对应。

图 8. 预览生成的主页

顺便提一下,当从工具箱导出信息中心后,生成的主页将以 index.html 文件的形式包含在其中,一同包含的还有一个 CSS 文件(welcome.css),该文件使您能够优化主页的外观。您可以调整字体样式、字体大小、背景颜色等等。

生成主页的另一种方法是从您的本地系统导入一个 HTML 主页。该页面必须被命名为从 index.html。选择Information Center > Home page菜单项,但是不要为生成的主页填充模板,而是单击名为DirecTory的单选按钮(包含 index.html 页面),然后遵循说明完成操作。

预览信息中心

隐藏导航蓝图

在预览您的解决方案信息中心时,注意您的用户只会看到导航视图的某些部分(您曾向其中拖拽内容)。导航视图的其余部分作为不可见的蓝图或计划帮助(planning aid)。您不需要删除未使用的部分。

一旦将内容片断(比如文件)拖拽到导航视图后,您就可以开始预览定制的信息中心了。信息中心导航视图将只显示已用内容填充了的部分。鉴于这个原因,最好不要删除现在尚未使用的部分,因为以后可能会用到它们。

要预览信息中心:

单击菜单栏中的Information Center > Preview。

等待信息中心显示出来。查看工具箱底部的 Console 区域中的状态。

当信息中心显示出来后,尝试使用导航树和搜索功能。

完成预览后,单击 Preview 选项卡页面中的 “X”。

图 9. 预览信息中心

在图 9 中需要注意,工具箱生成各种 HTML 页面来显示您为内容库中的文件和其他内容提供的信息。页面提供了一个占位图(site.gif),可以使用您自己的图形替换它。例如,可以使用一个公司或项目徽标替换图 9 中的 Product presentation 旁边的箭头图形。等到将信息中心导出以用于交付后,可以替换图形。

故障排除技巧:

如果工具箱冻结运行或者无法响应,那么要立刻使用工具箱右上角的 “X” 按钮退出。对来自工具箱的任何消息单击OK。工具箱在重启后将恢复正常的行为。在预览信息中心时最常见的问题就是工具箱突然冻结运行。

交付信息中心

当准备好将信息中心提供给用户时,就可以导出该信息中心。在任何时候,都可以继续处理解决方案信息项目并导出它的后续屏幕快照。

要导出信息中心:

单击菜单栏中的Information Center > Export。

在生成的 Package 解决方案信息对话框中,为导出的信息中心指定一个目的地。单击Finish。

在将信息中心导出为 ZIP 文件时,可继续使用工具箱处理其他行为。

测试已交付的信息中心

解决方案信息中心的接收方将对信息中心进行测试。

从 *_package.zip 文件提取解决方案信息中心。

导航到包含批处理文件的目录中,这些批处理文件用于启动解决方案中心 IC_start.bat。

将 IC_start.bat 文件发送到一个文件编辑器,比如 Notepad。

或者,选中 -port 参数,例如 -port 8888。如有需要,将其调整为一个不同的端口。

关闭 IC_start.bat 文件。双击 IC_start.bat 以运行它。将显示一个系统命令窗口,其中将展示进度。

使用一个 Web 浏览器查看信息中心。

(可选)在您自己的桌面上测试信息中心,只需输入:http://localhost:8888/help/index.jsp

测试是否能够远程查看信息中心,输入:http://your.host.name:8888/help/index.jsp

当希望关闭信息中心时,双击 IC_end.bat 并关闭浏览器窗口。

图 10 展示了一个解决方案信息中心示例,其中运行了一个演示。

图 10. 使用工具箱创建的信息中心的示例

结束语

您刚刚创建了自己的第一个信息中心。使用工具箱来创建一个完整的信息中心,或者从一个小的信息中心入手,然后花些时间来将文档收集到工具箱,从而以一种美观的、持续的和可扩展的方式交付。至于是否美化信息中心的外观,或者保持最初的外观,这完全取决于您的业务需求。祝您愉快!

肯承认错误则错已改了一半

使用定制Eclipse信息中心为IT解决方案编制文档,第1部分

相关文章:

你感兴趣的文章:

标签云: