什么是帮助创作工具（Help Authoring Tool）：优点、功能和示例

介绍

帮助创作工具（Help Authoring Tool）是企业中流行的软件解决方案。它们通常属于开发软件类别，因为它们通常用于编写软件文档或记录其他技术产品。

事实上，HAT 几乎可以用于任何需要生成可靠文档的行业。它们是内容开发工具，可帮助您为各种平台生成文档，并管理针对不同受众的大量内容。

对于许多帮助创作工具，需要进行专业培训。在其他情况下，它们开箱即可使用。

什么是帮助创作工具 (HAT)？

“帮助创作工具是旨在帮助技术作者设计、发布和维护软件帮助文档的程序。生成的文本用于解释指南、手册和帮助文件。” — G2

市场上有各种各样的帮助创作工具。帮助创作工具通常会促进内容创建过程，并且旨在由专业技术作家使用。要成为帮助创作工具，软件必须：

拥有编辑文本、数据或代码的工具

提供源文本的输入

提供帮助文件的输出

拥有添加索引、内容表或图像的工具

提供界面定制工具

实际上，您在某种程度上将文本内容视为代码。 HAT 通常由管理大量遗留文档并希望以不同格式跨多个渠道发布文档的企业公司使用。

帮助创作工具可帮助您单一来源内容。这意味着内容创建是集中的，源文件保存在数据库中——单一来源。

在构建过程中，您的内容会输出为不同的格式，包括从电子书到 PDF、印刷手册到 HTML 网站、CHM 文件到上下文帮助 - 所有这些都来自这个中心源。可能的文档输出列表相当无穷无尽。通常，您对 HAT 的选择取决于它支持的输出。

帮助创作工具的主要功能

正如我们已经提到的，HAT 与其他类型的软件有一些明显的区别。

以下是您可能期望的功能的快速列表：

文件导入

所见即所得文本编辑器

CSS编辑器

预览编辑器

代码视图

帮助输出 – CHM、PDF、HTML、HLP、ePUB

项目管理

媒体库

主题、片段和变量

现在我们将更详细地了解这些功能在实践中的样子。

当您购买 HAT 时，您会将软件解决方案下载到您的桌面并验证您的帐户。登录后，您将可以访问仪表板，您将在其中看到内容管理系统的内容。您可以开始创建文档源文件，也可以导入各种格式的现有文档。

这些源文件的创建和管理与最终版本的实际格式和输出分开。这使得更新文档变得更加容易，因为您可以利用主题、片段和变量来应用全局更改。基于主题的创作意味着为每个主题使用可以交换和重新排序的单独文本文件。

例如，您也可能不需要在其中一个输出中提供全套文档。您可能想要创建一本仅包含部分主题的印刷小册子，但随后还要生成一个包含全部主题的帮助中心网站。您可以通过帮助创作工具完成这两件事。

为了实现这些目标，帮助创作工具包含内容发布功能：所见即所得编辑器、代码视图、CSS/HTML/JS 格式化功能等等。

帮助创作工具的好处

帮助创作工具可以为您的企业带来许多好处。主要是，它们帮助您生成大量文档并管理您现有的文档。

使用主题、片段或变量等工具可以在文档中的多个位置轻松快速地进行更新。有些工具还允许您向不同的用户显示条件内容，以便您可以个性化帮助体验。多个技术作家和主题专家可以在同一项目上进行协作，并且您可以跟踪不同的版本。

帮助创作工具节省您的时间，以便您可以用更少的人完成更多的工作。 HAT 在数据库中集中管理源文件，因此内容与演示文稿分离。理论上，这意味着您只需编写一次，即可指示系统如何呈现您的内容，并通过单击按钮来发布您的文档。

当您为用户提供全面且有用的文档时，这可以帮助您降低支持成本。自助服务支持比雇用许多支持代理手动回答相同的问题更便宜。客户现在期望有一个自助服务门户。

帮助创作工具的常见用例？

公司可能会寻求帮助创作工具来帮助他们构建多种类型的文档。您可能需要创建：

知识库或支持门户

政策和程序文件

合规性和监管文件

标准作业程序

电子学习内容

通常，公司需要创建一系列文档类型，但每种类型使用大致相同的内容。

共同点是，您通常制作基于网络和印刷的内容，旨在帮助您的产品或服务的用户或您的内部员工。法律可能要求贵公司提供有关其产品和服务的最新且准确的文件。

例如，您可能正在为呼叫中心和业务办公室员工记录某种专有的内部计算机程序。或者，您可以记录一系列光纤技术的用户指南、安装指南、概念指南和快速入门指南。您可能正在为酒店预订系统创建一个帮助中心。您可以创建员工手册、学生电子学习中心，或为您的研究实验室制定合规政策法规。

在每种理论情况下，您可能有多种想要发布文档的媒介。您需要能够让技术作者团队协作处理源文件并自动生成已发布的版本。您不仅希望编写和格式化内容，还希望能够指示系统如何生成输出。

您必须能够随时更新您发布的内容（包括可能在很远的将来），并轻松更新同一内容的多个实例，而无需每次手动重新键入（或复制粘贴）新内容。可能需要将您的文档翻译成不同的语言，并不断更新您的本地化内容。

还有其他工具提供帮助创作工具提供的某些功能，或者执行类似的功能。例如，静态站点生成器还可以帮助您创建文档，但其功能更加有限。

顶级帮助创作工具解决方案

一旦您决定需要帮助创作工具，就有多种选项可供选择。我们在下面列出了四种流行的 HAT 工具中的一些，

Baklib： 是技术文档软件，可以实现主要帮助创作工具的许多基本功能。如果您正在寻找一个简单的解决方案来创建用户手册、说明手册或帮助文件，Baklib 可能更适合您。它与开发工作流程完美集成，允许您的团队在 Markdown 和所见即所得创作环境中发布内容。

MadCap Flare： 最全面的帮助创作工具之一，您可以使用 MadCap Flare 在 Web、桌面、移动和打印中单一来源您的文档。 Flare 提供了一些强大的工作流程和自动化功能，使创建文档成为一种更加无缝的体验。

Adobe RoboHelp：（Adobe 技术交流套件的一部分）——专注于创建在线帮助系统和移动体验。 Adobe RoboHelp 在上一个版本中进行了彻底重新设计，具有更现代的用户界面并删除了一些功能。

HelpNDoc： HelpNDoc 专门用于 Windows 操作系统，旨在模拟使用 Microsoft Word 程序的体验。 HelpNDoc 使用模板来创建时尚的应用程序和帮助网站。

如果您想详细探索更多工具，可以查看我们关于最佳帮助创作软件和工具的文章。

知识库软件作为帮助创作工具的替代品

一些公司想了解知识库软件和帮助创作工具之间的区别。知识库解决方案就像 HAT 的更专业版本。

知识库软件可帮助您为客户或员工创建在线知识库，并提供用户友好的内容发布流程。知识库软件可能由专业技术作家以外的人使用，例如您的开发人员、信息设计人员或客户支持代理。

相比之下，HAT 面向多种平台和格式，并提供单一来源发布系统。您的文档在数据库中进行管理，并且已与最终输出格式分离。重点通常是以 XML 或类似格式编写文档，并对其进行操作以在桌面、Web、移动和打印中使用。

知识库软件意味着同一个人或团队可以管理内容制作和最终用户支持。帐户持有者可以编写、编辑和发布内容，查看内容在后端的表现以及管理用户反馈。知识库通常与您的主要品牌网站一起托管，或者在您的软件产品中进行上下文链接。

免费与开源帮助创作工具

您可能会问，既然有这么多免费软件解决方案，为什么要选择付费专有解决方案呢？

使用免费的帮助创作工具很诱人，尤其是在您不确定某个工具是否适合您的情况下。对于任何企业来说，降低成本都不是一个坏主意，但同样正确的是，天下没有免费的午餐。

首先，免费并不是帮助创作工具的答案。首先问问自己为什么这个产品是免费的。这通常是因为您有某种有限的功能，它是开源的并且需要自行托管，或者它是免费的定价层并且您最终需要升级。

有时，如果您想将软件集成到开发工作流程中，免费解决方案可能是一个不错的选择，这就是静态站点生成器的用武之地。其中许多工具也是开源的，您可以从活跃的用户群和社区支持中受益。 OpenKM 或 PHPMyFAQ 等免费帮助创作工具在构建知识库方面很受欢迎。

如果您的组织遵循开源原则，您应该选择符合您价值观的工具。相反，如果您想先测试产品而不承诺付款，请选择像Baklib这样的解决方案。它可以免费试用，因此您可以了解它是否适合您的需求。

开源帮助创作工具

正如我们刚才提到的，开源帮助创作工具是制作文档的公司考虑的一种流行解决方案。这些工具包括 Sandcastle 或 Mediawiki，它们有很多优点和缺点。

开源帮助创作工具意味着您可以访问软件源代码，并且通常可以自定义您的解决方案以满足您的需求。您可以在软件许可条款的范围内做您喜欢做的事。您还可以将文档托管在与产品源代码相同的位置，这对于您组织的安全合规程序可能很重要。您正在支持开源软件行业，该行业促进让每个人都可以使用软件。

与此同时，开源帮助创作工具的上市时间将会变慢。您将需要内部开发资源来运行和维护这些解决方案。您无法从专门的软件支持中受益，并且如果您的解决方案背后的开源社区解散，那么您的产品将不再得到维护。

像Baklib这样的专有 SaaS 解决方案可以解决文档流程中的很多麻烦。

静态站点生成器

静态站点生成器是帮助创作工具的替代品，因为它们的用户体验是针对软件开发人员的。 SSG 被视为帮助创作工具的子集，专门针对开发人员和技术作家。它们通常是免费的，但您需要下载源代码并将其安装在您的系统上。

它们实际上是为了让开发人员能够从更好的博客体验中受益而开发的。现在有像 Hugo、Jekyll 和 Sphinx 这样的专业 SSG，它们是为制作文档的作者而设计的。

SSG 在技术上非常安全，因为当用户在页面上时不会调用您的服务器或数据库。与常规网站不同，您的内容不是动态生成的。所有内容都是在用户第一次请求页面时从服务器加载的，并且基本 SSG 中不包含交互元素。

开发人员可以通过使用自定义 JavaScript 或其他编程语言来添加交互性来扩展您的 SSG。理论上，基础设施更简单，因此技术编写人员可以在没有适当的开发资源的情况下构建自己的文档站点。

如果您有时间和资源致力于开发网站，那么 SSG 是一个不错的选择。如果让您的网站与软件产品代码库一起运行对您来说很重要，那么它是合适的。它允许您在本地创建文档，并在编写时预览更改。