产品文档终极指南：创建出色文档所需的一切

产品文档......它可能不是经营企业最性感的部分，但如果您希望您的企业成功，它是您不应该忽视的关键领域。

创建高质量的产品文档可以帮助您使您的客户更加成功，减轻您的支持负担，并且通常可以建立更好的业务。

但是创建产品文档需要什么？ 以及如何在您的网站上设置自己的文档？

这些只是我们将在产品文档最终指南中回答的几个问题。 这是我们将介绍的所有内容：

• 为什么你应该关心你的产品文档策略
• 一流文档的一些真实示例
• 最好的产品文档软件
• 创建更好的文档的八个技巧

您准备好改进您的企业处理文档的方式了吗？ 让我们深入挖掘！

为什么你应该关心你的产品文档策略

让我们先来看看为什么您不应该吝啬您的产品文档策略。

它使您的客户更成功

创建产品文档的最大好处是它使您的客户更加成功。 拥有更多成功的客户意味着更高的转化率、更低的流失率等等。

这是有道理的——如果客户无法弄清楚如何从您的产品中获得价值，他们将不会长期保持客户身份。

产品文档是教育客户的一种有用方法，以便他们获得尽可能多的价值。 当他们从您的产品中获得更多价值时，他们将更有可能继续付款，将您推荐给他们的朋友/同事等等。

它减少了您的支持负担

产品文档也是减轻人工支持渠道负担的好方法。

如果您的产品文档质量低下或不存在，这意味着您的客户每次出现问题时都需要联系您的人力支持团队。 这意味着花费更多时间响应支持请求。

您要么需要从发展业务中抽出时间来自己处理这些响应，要么需要聘请专门的支持人员（这需要花钱）。

凭借高质量的文档，客户将能够解决他们自己的许多问题，从而消除了他们寻求支持的需要。 您还可以构建您的支持流程，以促使人们在提出请求之前检查您的文档。

它可以成为一个很好的营销和销售工具

虽然很多人在帮助已经决定购买的人的背景下考虑产品文档，但良好的产品文档也可以帮助您首先吸引和转化更多客户。

从营销的角度来看，产品文档是长尾 SEO 关键字的金矿，您可以对文档进行排名。 您可能会对直接从 Google 访问您的产品文档的人数感到惊讶。 如果你组织好你的文档，你就有机会将这些人转变为客户。

您的文档也可以成为对购买产品犹豫不决的人的有用销售工具。 产品文档可以解决他们可能遇到的潜在售前问题，让他们相信您的产品可以满足他们的需求，并让他们相信他们会在需要时获得帮助。

例如，Stripe 以拥有一些最好的产品文档而闻名。 如果你去 Twitter，你会看到很多人推荐 Stripe，因为 Stripe 的文档质量很高：

它使您的员工更有效率

产品文档不仅适用于客户，它还可以成为您的团队成员在需要时了解您的产品和参考的重要资源。 对于新员工来说尤其如此，他们可能对您的产品没有广泛的知识基础。

四个伟大的真实产品文档示例

为了给您更多灵感，让我们看一些来自成功公司的真实产品文档示例。

1.条纹

我们之前提到 Stripe 是作为营销/销售工具的质量文档的最佳示例之一，因此您知道 Stripe 文档必须在我们的列表中排名第一。

2.阿迪恩

Adyen 是一个用于电子商务、移动和销售点支付的支付平台。 与 Stripe 一样，这意味着开发人员需要将其集成到自己的平台中，这需要出色的文档。 Adyen 并没有让人失望——在此处查看完整的 Adyen 文档。

3. 暮光之城

如果您不熟悉 Twilio，它是一种工具，可帮助企业通过短信、电子邮件、电话等方式在其平台中建立通信。 与 Stripe 和 Adyen 一样，这意味着企业需要将 Twilio 集成到他们现有的服务中，这需要一流的文档。 您可以浏览 Twilio 文档以查看一个很好的示例。

4. 松弛

Slack 是另一种工具，它具有非常好的编写和有用的文档。 您可以在此处浏览完整的 Slack 文档。

要查看更多示例，请查看我们关于最佳用户文档示例的完整帖子。

最佳产品文档软件

现在，让我们来看看如何开始在您的网站上提供更好的产品文档。

我们将在下一节讨论实际编写文档。 但是，在您编写文档之前，您需要一个地方来存储这些文章并让您的用户可以访问它们。

虽然您可以直接将这些文章添加到您的站点，但最好使用专用的产品文档软件。 除了组织您的内容并使访问者可以访问之外，好的产品文档软件还将包括其他有用的功能，例如……

• Ajax 搜索功能帮助访问者浏览文档。
• 搜索分析，以便您可以查看人们正在寻找的主题。
• 有用性数据，以便您可以跟踪每篇文章的有用性并在需要时进行改进。

这里有两个最好的解决方案……

英雄知识库（英雄知识库）

Heroic Knowledge Base 是免费的开源 WordPress 软件的插件，可让您轻松创建自己的自托管产品文档中心。

如果您已经将 WordPress 用于您的企业网站，您可以将 Heroic Knowledge Base 添加到您的网站以创建您自己的文档中心。 或者，如果您不这样做，您可以为您的文档创建一个专用的 WordPress 安装。 在后一种情况下，您可能还对KnowAll WordPress 文档主题感兴趣。

Heroic Knowledge Base 让您可以使用 WordPress 的内容编辑器添加所有文档，这样可以在需要时轻松包含多媒体内容。 您还可以访问 WordPress 的内置内容版本控制系统，该系统可让您轻松跟踪更改并比较文档的先前版本。

Heroic 知识库还添加了许多有用的功能，包括：

• 即时 Ajax 搜索。
• 搜索分析。
• 文章有用性评级。
• 文章文件附件。

英雄知识库仅需 129 美元。

Adobe 机器人帮助

如果您只是在网络上发布您的文档，那么像 Heroic Knowledge Base 这样的解决方案就是您所需要的。 但是，对于更多的企业级文档需求，您可能会遇到需要跨多个平台发布文档的情况，包括 Web、物理纸张、移动应用程序、PDF 等。

在这种情况下，您可能更喜欢 Adob​​e RoboHelp 等多平台文档创作工具。 个人使用每月 29.99 美元起，比 Heroic Knowledge Base 贵。 但是，如果您需要多平台创作，那么额外的价格可能是物有所值的。

如何优化您的产品文档结构和内容

现在您已经拥有了管理文档所需的软件，让我们来谈谈如何编写高质量的文章。 以下是构建文档和编写更好的帮助文章的八个关键技巧……

1. 了解你的听众

为了编写出色的产品文档，您需要了解您所写的受众（即您的客户）。

您为谁写作将影响您包含哪些信息以及您如何构建所有内容。 例如，如果您正在为开发人员编写文档，那么您的文档应该与为普通用户编写的文档完全不同。

您不想假设您的受众是专家并掩盖关键细节，但您可能会根据他们的身份假设一些基本知识。

2.了解不同的产品文档类型

有不同的产品文档类型，每种都需要不同的方法。 一些常见的类型是：

• 概述——这些文章概述了您的产品的某个领域是如何工作的，例如“入门”指南。
• 分步教程——这些文章向人们展示了如何执行特定任务。
• 参考- 这些文章解释了您产品中的特定概念。
• 故障排除——这些文章解释了如何调试/排除客户可能遇到的常见问题。

您正在处理的文档类型应该会影响您的编写方式和文档结构，因此在深入研究之前了解目标是什么很重要。

3. 在你的风格和命名约定上保持一致

为了使您的产品文档更易于客户使用，在整个文档中保持相同的样式和命名约定非常重要。 这将使客户更容易遵循您的文档并避免任何潜在的混淆。

为了帮助您做到这一点，为基本格式和术语提供样式指南可能会很有用。

4.使用简单的语言并保持简洁

凡事平等，简短而简单的语言总是胜过单词沙拉。 您的目标应该是用尽可能少的文字传达所有必要的信息。

您还应该尽可能避免使用行话或复杂的术语。 并非所有客户都拥有相同的知识库，有些客户甚至可能不是以您的文档语言为母语的人，因此使事情尽可能简单可确保每个人都能从您的文档中获得价值。

5. 在逻辑的、“问题大小”的文章中组织文档

为了让人们更容易浏览您的文档并找到针对他们特定问题的文章，您需要将文档分成逻辑段。 一般来说，每篇文章都应该专注于解决一个特定的问题。

当然，在这个主要问题中可能有多个子问题，但我们的想法是，您不想将两个完全独立的问题混入同一篇文章中，因为这会使人们难以搜索这些主题，而且他们当他们登陆文章时可能会感到困惑。

您的客户不会像阅读书籍那样以线性方式阅读您的文档。 相反，他们会根据他们目前遇到的问题跳来跳去。 将您的文章分成逻辑段有助于您解释这种行为。

6. 融入多媒体元素

虽然书面文本应该构成产品文档的核心，但它不应该是唯一的东西。 在有意义的地方包含图像和视频内容也很有帮助。

如果包括屏幕截图，您还可以在图像中添加注释以阐明关键细节。

7.使用标题并添加目录

在单个产品文档文章中，确保使用标题将文章划分为逻辑段，而不是只写一堵长长的文字墙。

为了帮助人们浏览文章，您还可以添加一个目录，让读者快速跳转到特定部分。

一些产品文档软件可以帮助您自动添加目录。 例如，Heroic Knowledge Base 插件带有一个内置功能，可以根据每篇文章的标题自动生成目录。

8. 始终改进和更新您的文档

最后，重要的是要记住创建产品文档不是一次性的事件。 这是一个持续的过程。

在基本层面上，您的产品可能会发生变化，因此更新您的文档以说明这些变化和您添加的任何新功能非常重要。

但除此之外，如果您选择 Heroic Knowledge Base 等产品文档软件，您将可以访问分析，以帮助您了解人们如何使用您的文档。 您可以使用这些分析来：

1. 跟踪人们正在搜索的内容，这可能表明您需要围绕这些主题创建文档（如果您还没有这样做的话）。
2. 查看哪些文章没有像您希望的那样帮助用户，这可能表明您需要对这些文章进行改进以提高他们的帮助。

立即开始创建出色的产品文档！

创建高质量的产品文档是对您业务长期成功的投资。 它可以帮助您……

• 让您的客户更成功。
• 减轻支持团队的负担。
• 首先吸引和转化更多客户。
• 提高员工对产品的了解。

在这篇文章中，我们分享了一些来自成功公司的优秀产品文档示例，以及一些关于如何编写和构建文档的技巧。

如果您准备好创建自己的产品文档中心，您可以使用 Heroic Knowledge Base 插件来构建您自己的由 WordPress 提供支持的自托管解决方案。 单击以了解有关英雄知识库的更多信息。