主题列表

香港证监会回家>技术写作>FrameMaker>

将FrameMaker用户手册转换为RoboHelp中的在线帮助

作者:Ron Kurtus(2001年3月24日修订)

许多技术交流人员的任务是使用Adobe RoboHelp(以前来自Macromedia)将用Adobe FrameMaker编写的用户手册和其他文档转换为在线帮助。

他们面临的问题不仅涉及从FrameMaker到RoboHelp,还涉及如何将内容以一种有效的在线帮助的形式放置。只要作者遵循系统的方法,解决方法并不难。

你可能会问的问题包括:

本节课将回答这些问题。



背景

在为一家位于威斯康星州的软件公司用FrameMaker编写了一份大型用户手册后,他们决定为自己的软件产品提供在线帮助,并希望用RoboHelp完成。本文提供了一个用于为他们的产品创建在线帮助的过程的案例研究,包括他们的产品和用户手册的关系,我如何将FrameMaker转换为RoboHelp,以及我如何从用户手册开发在线帮助内容。

产品与手册的关系

在继续开发在线帮助之前,了解产品的功能及其用户手册应该实现什么是很重要的。

作业成本产品

用户手册是为一个作业成本计算软件应用程序编写的。该产品帮助服务公司(如建筑行业)监控其项目的成本。它允许管理人员跟踪材料、劳动力和分包商费用等项目。应用程序的菜单系统是根据用户的作业成本功能或活动来安排的。菜单打开许多窗口或表单,用于输入或查看数据。

这是一个复杂的应用程序,允许用户向下钻取窗口中的数据,并转到子窗口以获得更详细的信息。有超过200个窗口可用于显示作业数据,每个窗口在用户手册中都需要自己的过程。手册的结构基于应用程序菜单系统的分层安排。

在FrameMaker中的用户手册

FrameMaker手册针对菜单的每个主要区域(如作业维护、输入事务和查看作业状态)划分为多个文件。这种安排(带有文件的描述性命名)也应用于帮助项目。手册和在线帮助中使用的文件名的连续性被证明在跟踪材料方面很有用。

我们的用户手册的目的是展示如何使用众多的作业成本计算窗口,以及它们之间的导航。手册大约450页长,有250多个章节。大多数章节都包含一个过程,并带有几个屏幕截图。当放入WinHelp时,每个部分都会生成一个或多个帮助主题。

在开始之前,在FrameMaker书中使用了特殊的段落样式来保持一致性并帮助文档,并且选择了具有美学吸引力的字体。在写作过程中,单词和短语被标记为索引。这一点非常重要,因为索引是在线帮助中使用最多的功能。在FrameMaker中索引项自动转换为RoboHelp。

将文件转换为RoboHelp

将在FrameMaker中编写的书籍转换为适合使用RoboHelp的格式的过程相对简单。它包括将FrameMaker文件转换为Microsoft Word,然后在Word中重新格式化文本,使其易于在RoboHelp中使用。

将FrameMaker文件转换为Word

如果FrameMaker文件包含任何图片或图形,则无法轻松将该文件转换为Word。因为我们的手册包含了大量的屏幕截图,以及小图形来指示鼠标移动和警告,所以有必要从每个FrameMaker文件中删除所有这些内容。这些图形中的许多可能不会在在线帮助中使用,或者不适合帮助格式,因此删除它们不是问题。

删除图形后,我简单地将这些文件保存为Word文件。这个过程是无痛的,除非有一两个图形不小心留下了。因为我之前已经命名了FrameMaker文件来反映它们的功能,所以Word文件的名称将保持不变。

重新格式化的文件用于RoboHelp

段落和字体样式从FrameMaker文件转移到Word文件。当Word文件转换为RoboHelp时,现有的字体大小和类型将保持不变。每个标题将自动更改为标题1,并成为在线帮助的主题标题。

我想去掉FrameMaker文件中使用的所有段落样式,并使Word文件尽可能“干净”。这可能没有必要,但我觉得摆脱所有的旧包袱可以防止潜在的问题。我改变了所有的样式,除了标题,以正常字体Arial 9。这将符合WinHelp中常用的样式。我还将所有的标题文件更改为Arial 12,以便在RoboHelp中自动构建主题。

开发帮助项目

文件转换成Word后,我创建了一个帮助项目,在RoboHelp版本7中选择WinHelp 2000选项。这个帮助项目的两个重要创新是使用Word的大纲功能来帮助组织和将主要程序转换为带有弹出解释的图形。

二手WinHelp 2000

我们决定使用RoboHelp 7的WinHelp 2000特性,而不是标准的WinHelp 95格式,因为这是未来的样子。WinHelp 2000看起来像微软的HTML Help,它被用于windows 98和Office 2000产品中。唯一的区别(也是优势)是WinHelp 2000仍然基于Windows 95帮助引擎,因此避免了可能的兼容性问题。

winhelp2000似乎比winhelp95更容易导航,因为内容总是在他们所谓的资源管理器视图中可用。使用WinHelp 2000的另一大优势是在线帮助更容易创建。您不必指定跳转到的窗口类型。辅助窗口在WinHelp 2000中不使用。

WinHelp 2000的一个很好的特性是,您可以将图形作为水印添加到非滚动区域。我插入了公司标志作为水印,这样它就显示在每个主题标题的左边。WinHelp 2000和HTML帮助的一个缺点是帮助窗口通常比WinHelp 95大得多,而且通常覆盖了应用程序的视图。

Word概要文件

当您在RoboHelp中创建一个新主题时,主题标题在Word中成为标题1。我希望在Word中工作时能够区分主要部分和其子部分,以帮助组织我的材料,但我不希望这些主题在在线帮助中看起来有任何不同。我使用Word的大纲功能,将每个子节的标题一直更改到标题4。这使得部分组织非常类似于用户手册。

我重新格式化标题1 - 4的字体样式为12点Arial。这样,我可以在Word中查看大纲,轻松地重新组织文件的位置。这不会影响在线帮助中的任何内容,但它使保持逻辑顺序变得更容易。我还将标题设置为浅蓝色,以增加一点活力,并与主题窗口非滚动区域中的公司标志搭配得更好。

从程序到图片

在试图简化我们填写各种工作成本窗口的程序时,我意识到在许多情况下,使用程序并不是做事的最佳方式。此外,有些程序的长度远远超过10个步骤,这使得它们很难遵循。

关注用户需求

我意识到用户不需要编号的指令来填写文本字段或单击某些按钮。相反,这个人想知道具体的物品是什么意思,如果你使用了这些物品会发生什么。因此,我决定用缩小尺寸的窗口图片替换主要程序,并使用弹出窗口来解释窗口中的每个项目。其中一些弹出窗口将包括跳转到另一个主题或选择其他弹出窗口以了解更多细节。

概述了弹出窗口

在RoboHelp中把它做成一个主题后,每个弹出窗口都被勾勒出来,在Word中作为标题6,字体设置为Arial 9粗体。“保留下一个”段落功能被关闭,弹出标题显示在帮助中。弹出窗口列在它们的主题下面,使它们很容易在Word中找到和编辑。

使用减少的屏幕截图

使用带有弹出窗口的Advanced Job Cost窗口的屏幕截图被证明是向用户提供帮助的一种非常有效的方法。这个想法的一个主要结果是,我们意识到,也许我们的用户手册并没有以最好的方式解释材料。此外,在线帮助可能是提供用户真正需要的信息的更好媒介。

结论

FrameMaker文件可以通过几种方法转换为适合在RoboHelp中使用的Word文件。使用这个版本的FrameMaker,有必要在转换之前从文档中删除所有图形。另一种不那么繁琐的方法是复制和粘贴部分。FrameMaker样式可以从Word文件中删除,以减少混乱。RoboHelp的WinHelp 2000是获得HTML帮助外观的一个很好的选择,但仍然使用WinHelp 95引擎。

在Word中使用大纲有助于保持材料的组织性,前提是主题标题的标题字体样式相同。开发在线帮助可以让你更好地组织你的信息。在这个作业成本计算应用程序的帮助中,带有各种项目的弹出窗口的屏幕截图被证明是一种帮助用户的有效方法。


寻求改变


资源及参考资料

罗恩·库图斯的证书

网站

Adobe软件-卖FrameMaker的公司

RoboHelp编写了大量Macromedia

技术传播学会

FrameMaker资源

(注意:开云官网安全可以从购买书籍中赚取佣金)

在FrameMaker上的顶级书籍


分享本页

点击按钮收藏或通过Twitter、Facebook、电子邮件或其他服务分享此页:


学生和研究人员

此网页的网址为:
www.开云体育网页版登入www.crittercrib.com/framemaker/
converting_framemaker_to_robohelp.htm

请将其作为你网站上的链接或在你的报告、文件或论文中作为参考。

版权所有©限制条款


你现在在哪里?

开云官网安全

FrameMaker主题

将FrameMaker用户手册转换为RoboHelp中的在线帮助




FrameMaker主题

基础知识

开发文档

输出

也看到



让我们把世界变得更美好

做最好的自己。

用你的知识和技能帮助别人成功。

不要浪费;保护我们的环境。

可以影响世界。





像冠军一样生活:

照顾好你的健康

寻求知识并获得技能

优秀的工作

有价值的给别人

有最大的字符

成为冠军!



开云官网安全帮助你成为那种可以被称为优秀的人冠军

Baidu
map