为客户创建杀手级 SaaS 产品文档

文档是 SaaS 公司最摇滚的部分，对吗？可能不会。

SaaS 产品的文档至关重要，尽管在 SaaS 初创公司的旋风中，它可能不是您列表中的重要内容。

它不仅仅是节省客户支持成本。您可能已经尝试发布一些文档，但现在是时候将您的文档提升到一个新的水平了。

由于 SaaS 公司采用订阅模式运营，因此您会定期与客户互动。这意味着您处于独特的位置，可以从文档中受益。

拥有可靠的 SaaS 产品文档直接有助于与客户建立牢固、持续的关系，从而减少客户流失。

流失是您成长的最大障碍之一，因此 SaaS 公司不能忽视拥有良好文档的需求。

为什么您需要杀手级 Saas 产品文档

现在，您可以抓住一个让客户更满意的机会。您可以通过反应性文档（为响应客户遇到的问题而创建的文档）减少客户支持请求。

对于需要扩展的 SaaS 业务，产品文档对于尽可能减少每个客户的票数至关重要。您可以通过文档使您的产品更加用户友好，从而减少客户流失。

SaaS 产品文档还有可能帮助您的初创公司改进入职流程。通过主动文档可以实现这一点。

您是否知道文档还可以帮助您提高在线知名度？是的！拥有杀手级文档的优势在于，它可以成为您内容营销策略的一部分，尤其是当您的 SaaS 产品与热门行业相关时。

最终，它可以而且应该包含在您使用 SEO 优化知识库的努力中。

例如，MailChimp 的知识库匹配与电子邮件营销相关的查询。如果您搜索“分析电子邮件订阅者”，他们的文档会显示在搜索结果中。这是潜在客户发现他们的产品的好方法。

如果您的知识库是主网站的子域，并且计入您的网站排名，则此方法效果最佳。

SaaS 产品文档需要重点关注的 9 个领域

要真正为您的 SaaS 用户创建适当的文档，您需要关注九个关键领域。

定义文档的受众

了解您正在创建的文档类型

在 SaaS 知识库中使用信息架构

对知识库内容进行分块以进行非线性发现

认可高质量的产品文档

区分代码文档和产品文档

使用适当的软件解决方案来托管您的知识库

使用多种格式的内容

不断迭代您的文档

我们现在将详细介绍如何为用户创建杀手级 SaaS 产品文档。

记录、存储和共享技术手册变得简单。

1. 定义文档的受众

如果您不确切知道您是为谁编写文档，则无法创建杀手级文档。

您的文档可能针对最终用户、内部员工、API 开发人员或这些受众的组合。

明确定义知识库的目标受众至关重要。如有必要，您应该将内容划分为单独的知识库。这一切都是为了尽可能具体。

在将时间和资源投入到 SaaS 的杀手级知识库之前，请先进行深入的访谈和调查。准确找出您的客户是谁。

即使是几封电子邮件询问那些联系您的支持团队的人的反馈也比没有好。

Wave 确切地知道它的知识库受众是谁——小企业主

2.了解您正在创建的文档类型

您知道技术文档有不同类型吗？您需要清楚自己正在创建哪一个。

SaaS 产品文档的类型可以包括：

教程

操作指南

说明

参考

清楚文档的类型意味着可以以最佳方式将其格式化并呈现给用户。您必须将不同类型的内容分开以避免混淆。

教程

教程用于实践学习，几乎不包含任何参考材料。它们是初学者用户熟悉软件基本功能的快速而粗略的指南。

操作指南

这些比教程更高级。操作指南引导用户完成完成一项特定任务的过程，而这是初学者可能无法制定的任务。这可能包括如何在程序崩溃时进行故障排除。

说明

解释是对概念的讨论。它们是理论性的而非实践性的。目的是让用户理解抽象的东西，例如软件周围的上下文。

参考

参考文档是软件的技术说明。这些在开发人员文档中可能比软件的最终用户更常见。如果潜在客户向其内部开发人员展示您的文档，它们可能仍然对最终用户有用。

3. 在 SaaS 产品文档软件中使用信息架构

SaaS 产品文档不仅仅是创建大量内容并将其扔给客户的问题。

知识库的布局和信息架构必须仔细设计。这将有助于学习过程。

信息架构 (IA) 为您的用户提供路标，向他们展示您的知识库。它受到命名约定、层次结构和类别的一致性等因素的影响。它向您的用户展示您的软件的潜在用例并提高您产品的投资回报率。

IA 还可以解决用户无意识的无能和有意识的无能。

无意识的无能是指用户不知道他们不知道什么。用户入门文档有助于教育您的用户摆脱这种状态。但剩下的时间呢？

自觉无能是指您的用户已经意识到他们不知道什么并且对您的软件存在问题。您的文档的工作是为他们提供适当的内容，以顺利解决他们的问题。

4. 对知识库内容进行分块以进行非线性发现

SaaS 产品文档不会像书籍那样以线性方式使用。用户将从不同的地方到达您的知识库。

在过去印刷技术用户手册的时代，每当新版本的技术出现时，每个版本的手册都必须重新印刷。它的编写风格旨在让用户能够从 A 阅读到 B，或使用目录。

这种趋势已经延续到文档领域。但现代浏览习惯意味着您的客户将从不同来源访问您的文档。每一段内容都必须作为独立的潜在登陆页面有意义。

关键是通过对内容进行分块来使内容易于浏览。将每条内容视为可回收的信息“块”。

确保每篇文章中涵盖的基本主题不超过一个，并将相关内容主题链接在一起。使用菜单和导航来帮助用户访问其他主题。

将您的内容视为云的一部分，而不是序列。

5. 认可质量文件

质量是一种主观状态，但您可以使用一些标准来评估您是否正在生成质量文档。

完整性

您不能对文档采取分散的方法，因为这会削弱信任。如果您的一项关键功能没有记录或文档已过时，这可能比根本没有文档更糟糕。

您的文档必须是一个完整的库，其中包含用户想要了解的有关您产品的所有信息。这并不意味着您将每一篇文章都包含在知识库主页上，但所有信息都应该在某个地方可用。

简洁的

同时，您包含的所有内容都必须高度相关。现在不是对您的内容进行宝贵或啰嗦的时候。

快速切入主题并删除任何多余的信息。如果您打算回去阅读文档以进行编辑，但您发现自己感到无聊。这将带来一个很大的危险信号，表明您的文档中信息过多。

仅使用表达观点所需的精确字数。将您要解决的任何问题的解决方案放在内容的开头附近。然后为那些逐步完成该过程的用户详细说明。

语境化

产品的最终用户将依赖您提供文档的所有必要上下文。这意味着无需猜测——用户必须立即了解他们是否找到了正确的内容。

您可以通过简要解释用户应该了解多少才能从您的文章中受益来提供上下文。 Mozilla 在他们的开发者文档中做得非常好：

简单的

简单不等于愚蠢。当您的文档很简单时，这意味着您决定在任何给定时间显示基本信息。

您的客户仅使用您产品的一小部分功能，因此请检查您的分析以了解最需要哪些文档。使用它来确定用户到达您的产品知识库时的发送路径。

Stripe 让它变得非常简单：

高质量的文档最终取决于了解您的受众、他们如何最好地学习以及您如何满足他们的期望。没有神奇的公式，因为每个观众都是不同的。

遵循这些久经考验的原则可以最大限度地提高您的成功机会，并聘请专业的技术作家来帮助您实现这一目标。

6.区分代码文档和产品文档

一些公司热衷于敏捷方法论，并遵循类似文档的代码方法来编写文档。虽然这可能是一种非常有用的方法，但 SaaS 产品文档遵循稍微不同的文档编码流程。

产品文档应根据需要经常更新——当发现错误或产生新内容时。它不一定符合您的开发周期以及您希望发布代码的频率。此外，期望您的技术作者或支持代理学习使用 Github 等开发人员工具来发布文档可能不太现实。

有时，软件的最终用户是开发人员，但这仍然无法使产品文档与代码文档相同。代码文档专门针对代码，通常旨在改善内部开发人员之间的沟通。面向公司外部受众的产品文档。

不同的团队和团队成员应该负责交付不同类型的文档——即使他们都在生成“文档”。评估应该在不同的层面上进行以衡量成功，因此不要强迫每个人都使用相同的工具或流程。

7. 使用适当的软件解决方案来托管您的知识库

如果您销售 SaaS 产品，您通常需要一个在线知识库来存储您的帮助内容。知识库软件解决方案非常丰富，但专门针对 SaaS 文档设计的却很少。

Madcap Flare等技术创作工具适用于以多种不同格式（套印和网络）制作文档的大型企业。对于一般的 SaaS 公司来说，这些都太重要了，不合适。

其他针对企业的知识库解决方案也有相应的价格标签。 SaaS 初创公司需要能够以合理的预算进行扩展的软件。

而且由于您可能已经拥有满意的帮助台解决方案，因此您可能不希望将知识库与支持软件捆绑在一起。您只需要一个简单的知识库。

由于您通过网络提供订阅软件，因此您需要一个以相同方式工作的工具。您需要 SaaS 知识库解决方案。

我们自己的产品Baklib是针对SaaS公司的知识库软件，您可以注册免费试用。

8. 使用多种格式的内容

有时，文档制作者喜欢用不同的格式来为其内容增添趣味，例如：

图片

视频

截屏视频

声音的

交互式代码示例

通常一张图片真的胜过一千个单词，并且可以改善用户的学习体验。

但请记住 - 视频和截屏视频的更新可能比书面文档更棘手，并且在国际化方面您可能会遇到问题。

屏幕阅读器的用户也无法访问视频和图像，因此您应该始终提供书面版本来配合您的视觉效果。这最终可能会带来很多额外的工作。

这并不是说您不应该使用视频，因为它们是传达产品信息的一种令人难以置信的方式。只需注意维护和可访问性问题即可。

9. 不断迭代您的 SaaS 文档

您的 SaaS 产品文档永远不会完成。它总是在不断发展，就像您的产品不断发展一样。

大多数 SaaS 公司都承认客户服务主要在网上进行，因此他们的知识库应该在网上。软件开发的本质意味着他们熟悉持续迭代的概念。事实上——他们的业务就是建立在它之上的。

这导致一些纪录片制作人员遵循类似文档的代码方法（正如我们之前提到的）。这意味着借鉴软件工程的原理，并将文档与代码保存在同一存储库中。

这是否适合您的初创企业必须根据具体情况来决定。但是，您必须使您的文档与产品的最新版本保持完全同步。

客户在任何时候都不应该能够访问不完全准确的文档。这可能会损害您产品的声誉并破坏您的可信度。

最后的评论

有些人认为一个好的产品应该只是记录自己。这意味着该产品非常用户友好，根本不需要任何文档。这种方法意味着，如果您的产品需要文档，那么您在用户体验方面就失败了。

事实上，大多数软件产品都具有足够的复杂性，并非每个功能都是显而易见的。并非软件的每个用例都总是直观的。这就是杀手级 SaaS 产品文档软件真正派上用场的地方。

文档的重要性都源于无意识的无能，或者您的客户不知道他们不知道的事情。

SaaS 产品文档是您减少客户流失和提高客户满意度的无声伙伴。我打赌你已经等不及现在就开始了！

下一步

如果您有知识库，请查看最热门的搜索词。如果您不这样做，请采访您的一些客户，了解他们在使用您的软件时遇到的最大问题。然后，为您的知识库内容创建一个计划，并围绕该计划构建您的 SaaS 产品文档。

发布您的内容并不断完善您的知识库，构建新流程以确保成功。

使用知识库软件可以使整个过程变得更加高效。

您的文档需要一个量身定制的房子来居住。考虑投资像 Baklib 这样强大的独立知识库软件

开始你的免费试用

经常问的问题

产品文档的目的是什么？

产品文档的目的是通过共享产品的相关信息来帮助与客户建立牢固、持续的关系，从而减少客户流失。

如何编写产品文档？

确定文档的目标受众，然后使用信息架构通过提供路标来引导用户浏览知识库，并将知识库材料划分为多个块以进行非线性发现。此外，将代码文档与产品文档分开，并使用多种内容形式，例如图像、视频、截屏视频、音频和交互式代码示例。使用适当的软件解决方案来托管您的知识库。

技术写作有哪些不同类型？

SaaS 产品文档的类型包括教程、操作指南、解释和参考？