如何使用 WordPress 构建帮助创作工具

已发表: 2022-04-28

优秀的技术作家永远不会远离他们值得信赖的帮助创作工具 (HAT)。

技术写作行业的主力 - 一种帮助创作工具，可以承受压力并改变“使复杂的事情变得简单”的艺术......嗯，小菜一碟。

HAT 是技术作家的生产力最大化工具。 10x 技术作家牢牢把握住了他们游戏的这一面。

经过这么多阶段的反复塑造和编辑副本，使其完美契合目的……

…您确实需要一个可以与您一起工作并帮助您将所有精力集中在制定最佳文学产品上的 HAT。

HAT 的概念并不新鲜。

他们一直在身边。

有些人可能会说，如果它们是一张全家福，它们可能会变得有点卷曲、棕褐色，甚至失去相关性。

例如，在许多情况下，拥有 WYSIWYG 编辑器被认为是一项高级功能。

但是从更侧面思考，是否有应用内容管理系统 (CMS) 的多功能性和多方面可转移优势来将 HAT 推向 21 世纪的案例？

我们认为，就 WordPress CMS 而言——世界领先的网络构建平台和最受欢迎的 CMS 软件……

……答案是：是的。

但是不要只相信我们的话，为什么不花几分钟时间深入研究一下为什么 WordPress CMS 是自~~切片面包~~意式浓缩咖啡以来技术作家的下一个最佳选择。

这是使用 WordPress 构建帮助创作工具的 HeroThemes 指南。

当今技术作家的典型需求

今天的技术写作涵盖了许多专业科目。

政府公共政策
IT计算
金融投资
房地产

……名单还在继续。

但是，作为技术领域复杂的翻译人员的严格要求是日常任务。

根据英国政府数字服务部的技术作家、服务设计和保证部的 Khidr Suleman 的说法，他的日常职责如下：

参与用户研究
创建内容策略
向高级利益相关者提出计划
设计和原型化用户旅程
讨论、编辑和（当然）写作内容

相当多样化。

然而，最后但并非最不重要的是（当然）在做他们真正做的事情。

但是写作（尤其是技术写作）是一个过程，而不是一种活动。

一场职责接力赛，共同导致文件交付。

简而言之，技术写作可以描述为“……捕获、组织和维护有关快速变化的软件系统的知识”的过程——Atom Bank

因此，技术作家生活中的一个共同特征是处理存储库和知识库。

例如，记录引文或专家评论的片段。以及以事实或数据的形式检索金块以验证论点。

简而言之，数据存储、搜索和定位或发现的便利性——除了写作——也是帮助创作工具的重要相关功能。

2022 年的帮助创作工具是什么？

如果要相信帮助创作工具的第 1 页 Google 定义的大部分内容，则准确的描述应包括：

制造
管理
出版

…文件。

大多数人声称更好的身份是“内容管理系统”。

诚然，该术语往往包含在 CMS 供应商撰写的文章中（在这方面，本文不会有任何不同），但如果我们检查使用的准确性 - CMS 毕竟是 HAT 的合适标签。

它从字面上帮助技术作家编写帮助文档。

至于准确指出我们所说的帮助是什么意思——我想对于你可以接受的范围没有硬性规定。

这真的取决于：

软件制造商对技术写作学科的了解程度，以及；
他们是如何说服他们满足需求的

在大多数情况下，HAT 专注于使起草和编辑基础正确。

并在顶部提供一些模板、样式和编码。

但问题是……

…仅这些功能就足以满足现代技术作家的苛刻要求吗？

我们为什么不问几个？...

在此反馈摘录中，受访者（技术作家）对传统 HAT 功能与传统 CMS（Drupal）进行了比较评论：

“作为 Drupal 的管理员，您可以查看页面列表，但一次只能编辑一个页面的属性。 没有多选和拖放。 所以主题管理可能非常费力。”
“如果你删除一个页面，那么指向它的所有链接都会中断，并且没有任何消息可以警告你。
在页面中创建链接时，您必须知道目标页面的路径和名称——没有可用页面的有用列表。”
“开箱即用没有所见即所得的编辑器。 对于大多数 HAT 用户来说，这是必须的。 你只能用完整/过滤的 html 编写你的内容。”

（来源：樱桃叶）

在这篇评论中，另一位职业技术作家讨论了他认为 HAT 软件未来趋势的两个理想功能：

“Facted search：当用户单击搜索选项卡并搜索项目时，用户可以使用相似的构面来缩小搜索结果，如下图所示。”
“使用任何标准的创作工具——Flare、RoboHelp、Author-It、Doc-to-Help——都会给你留下一个荒谬的模型，即一个作者从一个单一的有利位置从一个单一的组织试图将一个海洋信息。 由于该模型站不住脚且不可扩展， HAT 将逐渐被基于 Web 的协作创作技术所取代。”
（来源：我宁愿写博客）

上面给出的见解扩展了传统意义上的 HAT 的范围，包括一个更加动态和协作的平台，以提高技术写作效率。

您是否应该考虑使用组件内容管理系统 (CCMS) 进行帮助创作？

粒度赠品控制。

在技术写作领域，在生产周期内更好地控制的优势可以提高效率，从而转化为更大的项目投资回报率。

这正是组件内容管理系统的用武之地。

什么是组件内容管理系统 (CCMS)？

组件内容管理系统是一个 CMS，其内容项不是页面和帖子，而是片段、段落和内容部分。

与您在 CMS 中制作新内容的方式相同，您将开始一个新页面或发布一个新页面。

使用 CCMS，您将启动一个新组件（页面或帖子的一部分）。

许多部分构成一个完整的页面，因此整个页面和帖子的最终结果是相同的，但是它们的制作方式被分成小块。

为什么？

规模经济。

当然，基于多个部分（每个部分都有自己的元数据、依赖项等）而不是一个自由流动的整个部分来构建页面可以说是更多的工作。

但是，对于具有大量主题交叉和内部引用的大规模复杂内容项目，组件级别的可重用性和粒度可互换性......

…CCMS 为写作团队提供了巨大的长期优势。

即，更快、更准确地完成工作。

HAT的主要特点是什么？

因此，我们逐渐坚定了我们对 HAT 的看法、它们的作用以及我们应该考虑的除了传统方法之外的外部优势。

但是对于 HAT deos 的所有内容，我们仍然值得全面参考。

通过这种方式，我们可以在考虑投资选择时比较“苹果换苹果”。

以下是最常见、最具包容性的 HAT 软件功能列表：

多种输入和输出格式：使用多种文件类型导入和导出数据
功能齐全的文字处理器：基于代码和可视化所见即所得编辑器
构建标签：分配主题标签以按主题关联文章
主题模板：使用预制模板在每件作品上抢占先机
Syntax highlighter : 有助于解决语法问题的亮点
合并项目范围元信息的标签：使用合并标签轻松插入可重复使用的片段，节省时间并限制错误
自定义 HTML、CSS、Javascript：使用自定义 Web 代码对功能和设计应用定制的触摸
合并项目内容：合并同一项目中的内容以产生混合结果。
可定制的网页主题：用于完善工具前端的开关、幻灯片和复选框，以改善您的用户体验
媒体存储库：所有图像、PDF、音频和视频文件的整洁存储区域
简单的用户界面：易于使用，所有相关控件都易于到达距离和定位
翻译：多语言交付
目录：易于使用的每篇文章中的跳转链接，用于浏览内容

在专用的 HAT 中——以上几点涵盖了引擎盖下预期的大部分内容。

构建自定义 HAT 的好处

如果我必须总结构建自定义 HAT 的主要好处，我会说：

掌握自己的工具集。

量身定制的工具集

当您拥有“您想要的”、“您想要的位置和方式”作为专业人士时，在节省时间和改善结果方面的投资回报是不可估量的。

您根本无法将使用“恰到好处”的工具与一组通用的“凑合”工具的体验进行比较。

因此，定制自己的 HAT 可能需要大量的前期工作和大惊小怪。

但从长远来看，场景是为您在每个项目中击败您的个人最好成绩而设置的。

可扩展

等待路线图的改进，或被挤进高级升级不需要使用自定义 HAT。

当然，您将自己负责维修和改进工具，但只需一点 DIY 时间，您就可以适当地延长 HAT 的保质期。

简而言之，随着您的 HAT 越来越好，您的结果也会越来越好。

更全面的表现

定制的 HAT 将从您的技术写作工作流程中消除所有琐碎或阻碍的烦恼。

您消除了所有瓶颈和时间消耗，取而代之的是功能、选项和配置，让您在完成项目的竞赛中顺风顺水。

您将轻松实现您认为以前可能的东西。

使用 Heroic Knowledge Base 插件制作 WordPress 帮助创作工具

所以，到现在为止，如果您准备好勇闯新领域并投入制作自己的 HAT，我们将为您提供合适的解决方案。

便于使用。

建立在超过 40% 的在线网站使用的平台上。

具有所有最佳功能 - 以及更多功能。

这是……我们关于谁使用 WordPress 制作 HAT 的快速指南。

最好的部分是根本不涉及任何代码。这种方法对初学者非常友好。

这是排队：

页面和文件的组织和分类
搜索、投票、反馈和分析
FAQ组件复制
处理票务查询的服务台
目录页面索引
术语库

关于“为什么使用 WordPress”的简短说明。

对于大多数专业人士来说，拥有最适合工作的工具（不管它叫什么）是最重要的事情。

当您沉浸在可交付成果中并且需要具有一定扭矩的引擎来挖掘您时，语义或名称调用并不重要。

这是 WordPress 作为制作自定义 HAT 的理想平台。

首先，它勾选了本文前面提到的功能系列中的所有基本框。它的核心产品开箱即用，轻松做到这一点。

WYSIWYG 和 HTML、CSS 和 JS 编码等功能是 WordPress（世界领先的内容管理系统）提供的标准功能。

但 WordPress 还拥有 500 亿美元的托管、插件和主题经济。

这些参与者负责提供一流的扩展和性能帮助，使该工具成为适合目的的定制工具。

总而言之，WordPress 及其插件伙伴为任何想要 DIY 自己设置的技术作家提供 HAT 的梦之队。

以下是我们推荐的使用 WordPress 构建您自己的在线市场的步骤的概述：

具有孤立类别的目录主页：一个中心页面，用作已完成项目和研究资源的参考图书馆索引。一个整洁的包罗万象的位置，用于访问您的技术写作日志。

使用 Heroic Knowledge Base 插件生成您之前发布的 HAT 内容的自动链接和逐项排列。

搜索、投票、反馈和分析：注意到我们在文章前面的贡献技术作者的合作呼吁，我们在我们的 WordPress HAT 解决方案的功能中集成了活力和参与。提供搜索、反馈和见解只会帮助开发更大的改进。

使用 Heroic Knowledge Base 插件来启用用户研究增强功能，以指导产品的迭代改进路线图。

FAQ 组件复制：针对常见问题配置细粒度组件控制，让您拥有更精简的生产以扩展大型项目的优势。

使用 Heroic FAQs 插件，通过简单的安装和血清代码，通过内置的可重用组件来装备你的 HAT。

通过工单处理查询的英雄收件箱：方便地提供用户支持工单，为您提供位于 WordPress 安装内的响应式电子邮件帮助通道。

使用 Heroic Inbox 插件将您的企业电子邮件收件箱集成到您的 WordPress 管理仪表板中。这为您在 HAT 中提供了一个统一的通信中心，从而节省了您花费在导航脱节工作流上的时间。

Heroic Table of Contents：跳转链接，方便您的文章浏览，帮助读者消化信息并提取价值。使用经典的 ToC 让您的作品更加易于使用。

使用 Heroic Table of Contents 为您的每篇文章添加一个自动填充的目录。

Heroic Glossary：编译一个 AZ 有用术语列表，作为访问项目关键词定义的快捷方式，让您在编写新项目时保持敏捷。

使用 Heroic Glossary 插件将可搜索的词汇表安装到您的 WordPress HAT 中 – 无需汗水，并且（再次）无需代码。

Aspose.Words：立即将 WordPress 帖子或页面转换为 DOC 或 DOCX 文件，反之亦然。弥合工作流程差距，使您的新系统与旧版 GDocs 或 Word 文档资产兼容。

使用 Aspose.Words 插件启用 WordPress 和 GDocs 或 Word 之间的双向文件转换。

Syntax Highlighter Evolved：在您进行自定义编辑时让 Web 代码脱颖而出，帮助您专注于细节而不会分心。

使用Syntax Highlighter Evolved使代码在您进行精通网络的编辑时变得美观。

结论

在这些先进的 CMS 时代，特制的 HAT 可能正在重新发明轮子。

实际上，即使是功能最先进的 HAT 也没有多少（如果有的话）可以做到具有某些配置的 CMS 无法做到的事情。

此外，使用 CMS，您还拥有额外的功能，可以为已经具有竞争力的产品增加优势。

CMS（市场领先的 WordPress 及其插件）提供的进一步潜力可以扩展同类 HAT 解决方案，超出您的预期。

有足够的空间来挠痒痒并继续使用 WordPress 进行创新——而且无需编码。

快速扩展的 3rd 方插件生态系统支持 WordPress 的市场份额优势，其专业产品推动了可能性的边界。

总而言之，我们相信，如果您希望进行面向未来的定制 HAT 投资，WordPress CMS 是理想的数字平台。

为什么不从今天开始？