创建面向客户的SaaS产品文档

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

为您的SaaS产品提供文档至关重要，尽管在SaaS初创公司的旋风式发展中，它可能并未排在您清单的前列。

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

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

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

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

为什么您需要SaaS产品文档

此时此刻，您可能正坐拥一个让客户更满意的机会。您可以通过反应性文档（即为响应客户遇到的问题而创建的文档）来减少客户支持请求。

对于需要扩展的SaaS企业而言，产品文档对于将每位客户的工单数量保持在尽可能低的水平至关重要。您可以通过文档使您的产品更加用户友好，从而减少客户流失。

SaaS产品文档也有潜力帮助您的初创公司改进新用户引导过程。通过主动文档，这是可以实现的。

您知道文档还可以帮助您提高在线可见性吗？是的！拥有出色文档的优势在于，它可以成为您内容营销策略的一部分，特别是如果您的SaaS产品与热门行业相关的话。

最终，它可以也应该被纳入您使用搜索引擎优化知识库的努力中。

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

如果您的知识库是您主网站的子域名，这种方法效果最佳，并且有助于提升您的网站排名。

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

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

1. 定义您的文档受众
2. 了解您正在创建的文档类型
3. 在您的SaaS知识库中使用信息架构
4. 对知识库内容进行分块以支持非线性发现
5. 识别高质量的产品文档
6. 区分代码文档和产品文档
7. 使用合适的软件解决方案来托管您的知识库
8. 使用多种内容格式
9. 持续迭代您的文档

接下来，我们将详细介绍如何为您的用户创建出色的SaaS产品文档。

1. 定义您的文档受众

如果您不清楚为谁撰写，就无法创建出色的文档。

你的文档可能面向最终用户、内部员工、API开发者或这些受众的组合。

明确定义知识库的目标受众至关重要。如有必要，你应该将内容划分到独立的知识库中。核心在于尽可能地具体化。

在为你的SaaS投入时间和资源打造一个出色的知识库之前，请进行深入的访谈和调查。准确地找出你的客户是谁。

即使是向那些联系你支持团队的人发送几封邮件征求反馈，也比什么都不做要好。

Wave清楚地知道其知识库的受众是谁——小企业主

2. 明确你正在创建的文档类型

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

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

• 教程
• 操作指南
• 说明
• 参考文档

明确文档类型意味着可以为其优化格式并呈现给你的用户。你必须将不同类型的内容区分开来，以避免混淆。

教程

教程用于实践学习，包含很少或完全不包含参考资料。它们是针对初学者的快速入门指南，帮助他们熟悉你软件的基本功能。

操作指南

这些内容比教程更深入。操作指南会引导用户完成特定任务的过程，这些任务通常是新手无法自行构思的。例如，可以包括程序崩溃时如何进行故障排除。

解释说明

解释说明是对概念的探讨。它们更偏向理论而非实践。其目标是让用户理解某些抽象内容，例如您软件背后的背景信息。

💛🧡🧡客户评价：我们的IT团队需要一个存储库进行知识管理，以便我们的团队知识可以传承下去。在此外，我们正在寻找一种解决方案，使我们能够提供为我们的团队成员提供自助服务。Baklib提供了一个易于部署的低成本的解决方案，超出了我们的预期。优秀的知识管理平台。

参考文档

参考文档是您软件的技术性描述。这类文档在开发者文档中可能比在最终用户文档中更为常见。不过，如果潜在客户将您的文档展示给其内部开发人员，它们对最终用户可能仍然有用。

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

SaaS产品文档不仅仅是创建大量内容并抛给您的客户那么简单。

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

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

信息架构也处理用户的无意识无能力和有意识无能力。

无意识无能力是指用户不知道他们不知道什么。用户入门文档可以帮助用户摆脱这种状态。但其他时候呢？

有意识无能力是指用户已经意识到他们不知道什么，并且在使用您的软件时遇到了问题。您的文档工作就是为他们提供合适的内容，顺利地解决他们的问题。

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产品文档体系。

发布您的内容并持续改进您的知识库，建立新的流程以确保成功。

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