SaaS 产品的文档至关重要，尽管在 SaaS 初创公司的旋风中，它可能在您的列表中并不重要。它不仅仅是为客户支持节省成本。您可能已经在发布一些文档时做了一些尝试，但现在是时候将您的文档提升到一个新的水平了。

由于 SaaS 公司采用订阅模式运营，因此您可以定期与客户互动。这意味着您具有独特的优势，可以从文档中受益。拥有可靠的 SaaS 产品文档直接有助于与客户建立牢固、持续的关系，从而减少客户流失。流失是您成长的最大障碍之一，因此 SaaS 公司不能忽视拥有良好文档的需求。

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

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

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

SaaS 产品文档也有可能帮助您的初创公司改善入职培训。这可以通过主动文档来实现。

您是否知道文档还可以帮助您提高在线知名度？是的！拥有杀手级文档的优势在于它可以成为您的内容营销策略的一部分，特别是如果您的 SaaS 产品与流行行业相关。最终，它可以而且应该包含在您使用 SEO 优化知识库的努力中。

例如，Baklib的知识库匹配与技术文档的查询。如果您搜索“技术文档”，他们的文档会显示在搜索结果中。这是潜在客户发现其产品的好方法。如果您的知识库是主网站的子域，并且计入您的网站排名，则此方法效果最佳。

专注于 SaaS 产品文档的 9 个领域

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

• 定义文档的受众

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

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

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

• 识别高质量的产品文档

• 区分代码文档和产品文档

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

• 对内容使用多种格式

如何创建杀手级 SaaS 产品文档？

• 1. 定义文档的受众

如果您不知道为谁编写它，则无法创建杀手级文档。您的文档可能面向最终用户、内部员工、API 开发人员或这些受众的组合。

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

在为您的 SaaS 投入时间和资源在杀手级知识库上之前，请进行深入的访谈和调查。准确了解您的客户是谁。

即使是几封电子邮件，要求那些与您的支持团队联系的人提供反馈，也总比没有好。

Wave确切地知道其知识库受众是谁 - 小企业主

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

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

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

教程

操作指南

解释

参考

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

教程

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

操作指南

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

解释

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

参考

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

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

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

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

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

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

无意识的无能是指你的用户不知道他们不知道什么。用户载入文档有助于引导用户摆脱此状态。但是其余时间呢？

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

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

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

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

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

关键是通过分块使您的内容可略读。将每条内容视为可回收的信息“块”。

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

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

• 5. 识别高质量的文档

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

完整性

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

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

简明

同时，您包含的所有内容都必须高度相关。现在不是珍惜或啰嗦您的内容的时候。

快速进入正题 ，删除任何多余的信息。 如果您打算返回并阅读文档以进行编辑，并且发现自己感到无聊。这将带来一个很大的危险信号，即您的文档中有太多信息。

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

语境

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

您可以通过简要说明用户在从您的文章中受益之前应该知道多少来提供上下文。Mozilla在他们的开发者文档中做得很好：

简单

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

您的客户只使用一小部分产品功能，因此请检查您的分析以查看最需要的文档。使用它来确定在用户到达您的产品知识库时向他们发送的路径。

条纹让它变得非常简单：

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

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

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

一些公司是敏捷方法的粉丝，并遵循类似文档的代码方法来编写文档。虽然这可能是一种非常有用的方法，但 SaaS 产品文档遵循与代码文档略有不同的过程。

产品文档应根据需要频繁更新 - 当发现错误或生成新内容时。它不一定与您的开发周期以及您希望发布代码的频率保持一致。此外，期望您的技术编写者或支持代理学习使用 Github 等开发人员工具来发布文档可能不是很现实。

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

不同的团队和团队成员应该负责交付不同类型的文档 - 即使他们都在制作“文档”。评估应该在不同的级别进行，以衡量成功，所以不要强迫每个人使用相同的工具或流程。

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

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

像Madcap Flare这样的技术创作工具适用于大型企业，通过印刷和网络制作许多不同格式的文档。这些对于普通的 SaaS 公司来说太重了，不适合。

其他针对企业的知识库解决方案，并带有与之匹配的价格标签。SaaS 初创公司需要能够以适中的预算感觉舒适的价格点扩展的软件。

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

• 8. 对内容使用多种格式

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

图像

视频

音频

交互式代码示例

通常，一张图片真的胜过千言万语，可以改善用户的学习体验。

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

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

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

• 9. 不断迭代您的 SaaS 文档

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

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

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

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

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

创建工具首选：Baklib

Baklib在线帮助文档有15+主题模板，随心切换，更有多场景适配，PC官网、手机端、小程序等嵌入。独立域名的添加使你的产品帮助中心页面能更快的被搜索引擎收录，且更权威，访客统计插件则能让你更清晰直白的了解到观看产品帮助中心页面的用户画像。团队协同方便内部问题的添加，同时加入站点权限的功能，让你的产品帮助中心页面针对制定人群开放。全文检索更是方便了内容的查阅。

Baklib协同文档工具

Baklib帮助文档制作平台，为你提供一个高效的帮助文档制作方式。提供多种免费插件，多种主题样式免费使用。

• 内容随时后台编辑，前台展示，随时可以更改；

• 多级栏目，问题分类展示，采用树状目录的结构，通过文档大纲，可以自动生成文档要点；

• 类似百度的搜索框，输入关键词就能找到相应文章，并且搜索结果关键词高亮显示；

• 采用类似word的编辑器，支持markdown，内容即写即存，支持数据的备份和导出；

• 手机、电脑、平板都能够写作，并且内容可以直接分享到微信、钉钉、QQ等平台，直接复制链接分享出去，可以内嵌到app、产品、网站中；

• 站点访问权限可以自己设置，有私密、公开和密码访问三种模式，可以随意选择。可以根据不同的内容来更改模式，对指定人群开放；

• 免费的二级域名，有利于seo优化和品牌宣传。

结语

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

实际上，大多数软件产品都具有足够的复杂性，以至于并非每个功能都很明显。并非软件的每个用例都始终是直观的。这就是杀手级SaaS产品文档软件可以派上用场的地方。文档的重要性都回到了无意识无能的想法，或者你的客户不知道他们不知道什么。SaaS 产品文档是您减少客户流失和提高客户满意度的无声合作伙伴。打赌你迫不及待地想现在开始！