by ClickHelp —专业的帮助创作工具


迁移到新工具对任何人来说都是痛苦的。 即使在您的公司中实施了新的Messenger,也仍然存在过渡期。 是的,由于发送消息是应用程序的主要功能,因此您仍然需要一些时间来习惯新的UI。
当您是一名技术作家,手头上有许多文档项目时,要迁移到新工具听起来像一场噩梦。 首先,让我们找出迁移到新的帮助创作工具的原因。 然后,讨论可以简化此过程的步骤。


效率低下是第一原因。 不使用专门为技术写作目的而开发的工具将始终导致效率低下。 另外,如果您已经在使用HAT,请注意工作流程/其他功能限制。 一些文档工具可能不够灵活,因此,您会注意到在工作过程中必须实施多少个变通办法。
另一个指标是创建技术文档时必须使用的第三方应用程序的数量。 您是否正在使用单独的工具来收集统计信息,将输出文件转换为所需的格式? 在那里,这是对时间和金钱的严重浪费,因此应考虑迁移。 附带说明:只要迁移原因有效,就应尝试选择最佳的执行时间-可能是在新产品发布后的某个时候,尘埃落定。
当然,对于每个帮助写作团队来说,合适工具的定义都会有所不同。 但是,如果您考虑一下,行业中的一些总体趋势可以帮助我们弄清现代帮助创作工具应该分享的一些共同特征。 我们最近发布了一篇题为“每个在线文档工具都应具备的功能”的文章,并列举了以下功能:单项采购技术,主题状态,用户/读者角色,即用型文档模板,相关统计。 您可以在此列表上进行调整以适应您的情况,并创建一个完善的在线文档工具公式,这将是您搜索的指南。
为了无缝地进行迁移,您需要确保当前文档编写解决方案的输出格式与新的在线文档工具提供的格式一致。


这是非常重要的一步,因为如果导出/导入选项不能很好地配合使用,则会浪费大量时间。 尽管如此,即使您找到了一些不错的输出/输入组合,也可能在迁移开始之前按顺序进行了一些内容清除。
这一点可以是可选的,但是由于很多人正在迁移其技术文档,所以我们不得不提一下。 在某些情况下,更容易在旧的帮助创作工具中对内容进行必要的更改。 例如,如果您将Word用作初始格式,要在迁移到ClickHelp时正确生成TOC,则需要确保在Word文档中设置了大纲级别。 ClickHelp将使用此信息为您自动创建目录。
另外,如果您重复页脚/页眉,则可能需要先删除它们,因为诸如ClickHelp之类的在线文档工具可将统一的页脚/页眉添加到所有主题。 您可以先尝试使用原始文档的一些片段来完成迁移过程,以查看哪些有效,哪些无效。


万岁! 您已完成迁移! 在这里,很大程度上取决于您完成之前的步骤时的了解程度。 另外,Obvious上尉要我提及要迁移的文档的大小和数量。
迁移本身并不那么可怕。 如果以ClickHelp为例,它支持大多数流行的导入格式,因此很可能一切都会顺利进行。 单击几下即可进行迁移,每个步骤都直观易懂。
相同的格式可以具有不同的版本,有时样式或其他元素不能完美地迁移。 如果您进行了试点迁移,我们在第4点中提到并事先准备了文档,那么应该只有一些小的不一致之处; 通常,样式受影响最大。


这是我们今天要讨论的最后一点,它只涉及将Web帮助迁移到新工具的技术作家。 在这种情况下,迁移结束后,重要的是不要忘记将所有旧链接重定向到新链接。
如果您找到了可以满足您所有需求的完美工具,而不必考虑内容迁移,那就太好了。 但是,我们也想在这里警告您-并非一切看起来都是如此。 新技术进入了技术写作领域,仅昨天看来好的和可靠的明天可能是个坏消息。 始终保持寻求进步,而不是停滞不前。 打破旧的基础可能很困难,但有时这样做是非常必要的。
祝您技术上写好运!
ClickHelp TeamAuthor,跨平台和设备托管和交付文档






最初发布在 clickhelp.com上 。