SaaS文档：驱动业务发展

近十年左右 SaaS 的兴起，让全球数百家公司成为了家喻户晓的名字。

但它们并非仅凭产品实力就达到这一地位。客户服务和支持是幕后一切顺利运行的保障——而其中很大一部分就是文档工作。

在网站的正确位置，以正确的风格提供适当的用户文档，对于将浏览者转化为买家至关重要。

这是因为如今人们非常重视网上有帮助的用户内容。毕竟，有多少次你曾因为一个网站没有包含本应显而易见的信息而感到沮丧？

很多人正在使用 Baklib 等知识库软件来制作优秀的产品文档。

在本文中，您将了解为什么好的文档对于打造强大的 SaaS 品牌至关重要，以及如何实际着手并使用知识库软件来完成这些文档。

2020年的文档现状

如果您浏览一些竞争对手的网站，您会注意到设计语言中的几个明显主题。如今的网站看起来与十年前不同，而十年前又与前一个时代不同。

有趣的是，虽然2010年和2000年的网站可能为访问者提供了大致相似类型的内容，但2020年的网站几乎普遍增加了一个全新的板块。

大多数企业已经转向开放内容文档，这样即使您尚未注册该软件，也能查看帮助文件。以前，您会在软件本身中阅读帮助文件，或者从安装CD附带的readme文件中阅读（还记得那些吗？）。

尽管让所有人访问帮助文件可能看起来不太直观，但实际上它有很多优势。

在网上树立自己的名声

其中最主要的是信息的来源。如果您看看今天的SaaS巨头，比如Salesforce，有整个由高级用户组成的论坛，互相分享如何使用Salesforce。

您的产品可能不像那样是公众必需品，但将您的文档放在网站上供所有人查看的优势在于，它能让人们更容易信任贵公司在产品支持方面的专业知识。

一个封锁其帮助文档（或者更糟的是，首先就有糟糕的文档）的公司，可能会被认为不如互联网上遍布的热情用户那么严肃，这些用户在讨论如何解决您软件的问题时，很容易插入对您竞争对手的推广。

通过将所有内容集中在一个地方，您使自己成为权威，并使其他人看起来像是在抄袭知识库中任何人都可以查看的文章。

提升您的搜索排名

企业拥有充满面向公众文章的知识库的另一个原因更实用一点：它能在网络搜索结果中获得更好的排名。

搜索引擎喜欢包含大量相关链接的内容以及大量相似且受欢迎的页面。由于文档常常会链接到其他文档页面，这意味着您的帮助台文章天生就有潜力获得良好的搜索排名。

当您使用内容丰富的页面设计，使文章包含图片、代码片段等元素时，这一点变得更加重要。这会使您的文章对搜索者更具吸引力，从而提升这些页面的排名。

理想情况下，这甚至会达到这样的效果：当用户搜索您的产品能做的某件事时，仅凭一个关键词，在谷歌搜索结果的第一页就能找到来自您自身文档的多个页面。

您可能会想，这不是内容营销和网站其他有趣部分该做的事吗？为什么文档要承担这个角色？

了解 Baklib 如何帮助 Dagle 简化其文档流程：

为什么文档对 SaaS 公司至关重要？

让我们面对现实吧。许多 SaaS 公司做出了好的软件，但不是伟大的软件。

目前市场上有如此多的初创公司，以至于任何一家公司的核心功能都容易被复制，这并非源于任何形式的商业间谍活动，仅仅是因为可供发明的独特功能已经不多了。

人们选择某个平台而非另一个的真正原因，在于 SaaS 中的服务部分。

至关重要的是，您的用户必须能够直观地使用您网站的功能，并尽可能地降低文化、设计或知识障碍。如果他们觉得您的产品不易使用，他们可以立刻转身选择其他人。

不过，自然没有人会期望自己第一次使用软件时就能立即上手。您的工作是让学习使用和解决问题的过程变得直观易懂。

这正是高质量文档的价值所在。当用户访问您的帮助台页面时，他们每次都应该能够根据经验判断出，哪里可以找到解决他们问题的正确信息。

您需要一个强大的搜索引擎，能够向用户展示所需文章的位置；同时，还需要一个易于阅读的文章分类层级结构，让他们知道可以在几秒钟内访问到相关文章。此外，所有这一切的设计风格需要与您的网站保持一致，这样用户就不会潜意识地感觉自己找错了地方。

那么，为什么必须投入时间和精力来编写有效的文档，而不是简单地让人接听电话和回复支持邮件呢？

事实证明，与被告知如何解决问题相比，用户更喜欢自己动手寻找答案。您需要满足他们的第一反应——在网站上点击浏览，看看是否存在一个自助服务区能够帮助他们。只有当他们尝试无果后，才应该引导他们使用联系表单。

如果用户能在您的网站上找到所需的答案，那么您的网站在他们眼中就是设计良好的，他们会乐于在未来更频繁地回访和使用。

此外，您可能也猜到了，编写文档比雇佣人员接听电话要便宜得多，即使将客服外包到海外也是如此。即使是兼职的电话支持，每月成本也可能超过一千美元，而即便是最昂贵的企业级知识库平台，其费用也不到上述成本的一半。

构建您文档的平台

到目前为止，我们已经多次提到知识库作为您可能想要使用的平台，但提及其他一些同样适用于某些公司的产品文档软件包也是公平的。

当然，对您而言最简单、最具成本效益的解决方案（除了完全没有文档之外）就是快速编写一份用户指南或回答一些常见问题，并将其放在您网站的一个静态页面上。

这样做设置起来毫不费力且免费，但存在几个明显的缺点。首先，您只有一个页面来帮助提升搜索排名。其次，每次软件更新时，您都必须手动更新它，而在SaaS中，这种更新可能相当频繁。

💛🧡🧡客户评价：Baklib作为面向客户和员工的封闭式知识库，通过自助式技术解放我们的支持团队和非技术文档。它还使我们的技术和非技术团队通过无缝审批流程，并能够查看任何更改，易于迁移，易于使用。

最后，一旦您需要回答超过十个或十五个问题（大多数用户仅针对一个登录界面就能提出十个或十五个问题），您真的应该将它们拆分到多个页面上，否则您的用户会感到分心。

然后，更新页面变得更加繁琐，而且当网站上有多个帮助页面时，网站管理员可能会对后端组织感到恼火。

另一种方法是使用免费的wiki软件，就像一些公司已经做的那样，建立一个易于编辑的帮助页面集合。

只要您对托管wiki软件感到满意，对于那些不想花时间去学习使用另一种专用知识管理平台的人来说，这可能是一个不错的解决方案。毕竟，大多数人都使用过维基百科，因此对这类平台的外观和工作方式有很好的了解。

然而，大多数wiki的设计往往相当欠缺，并且很明显，您是在将wiki解决方案生硬地附加到现有网站上，而不是平滑地集成一个自然的东西。

维基通常还具有相当糟糕的搜索功能——看看维基百科本身，就会发现其搜索功能似乎还停留在21世纪初。搜索是快速找到答案的关键组成部分，如果你的客户对你的文档平台感到沮丧，他们可能更容易对整个产品感到厌烦。

这就是为什么大多数人使用知识库（一些提供商也称为帮助台）作为其文档需求的基础。

知识库从一开始就不是像维基那样的全能型解决方案，而是专门用于添加和编辑帮助文章——并且要做得很好。许多知识库与CRM或其他帮助台软件功能（如即时聊天或客户问题跟踪）集成，而其他像 Baklib 这样的平台则完全专注于构建和维护帮助页面。

产品文档软件中需要关注的功能

没有一个完美的解决方案可以解决你所有的文档问题。然而，有一些关键功能是你需要留意和比较的。如果你正在考虑特定类型的技术文档软件，比如 知识库，请确保它在这些关键功能上实现得很好。

页面编辑器

正如你希望读者能够毫无困难地使用你的文档一样，你也希望你的编写者能够尽可能快速、轻松地编辑页面和添加新文章。

您希望您的页面编辑器在易用性上就像文字处理器一样，但同时具备一些关键功能，例如为高级编辑器提供Markdown支持。这样，您就可以添加所有必要的格式，而无需将手从键盘移到鼠标上。

您的编辑器还应具备良好的添加照片、视频和其他内容的能力。虽然您的文章通常应该简短（稍后会详细说明），但您绝对应该考虑添加多媒体内容来引导用户，特别是当您的用户界面文本密集，可能让非英语母语者感到困惑时。

在页面编辑器中，您还应该能够执行批量功能，例如编辑文章以及将文章从一个类别移动到另一个类别。毕竟，有时产品更新需要大幅调整文章的排序方式——如果可以的话，最好一次性完成。

搜索栏

尽管分类功能可能很强，但搜索栏才真正能让知识管理系统脱颖而出。

检查并查看当您输入一个基本关键词时会发生什么，例如“打开”。它是否会因为包含该单词而显示大量无关的文章，还是会智能地将最通用和基础的页面放在前面——因为搜索基本关键词的用户可能并非专家级别？

另外，当您故意输入拼写错误的单词时，也要查看结果。一个好的搜索栏会实施模糊搜索算法，以确保即使您的手指在键盘上打滑，也能找到您想要的结果。

在布局方面，搜索栏应被放置在显著位置，以便用户能够第一时间看到。它应该在移动端和桌面端布局中都保持良好的视觉效果。谈到设计……

自定义设计

虽然知识库有它们自己的设计语言（例如，许多人大量使用表情符号），但您仍然希望有能力让您的文档在页面上看起来天衣无缝。

大多数SaaS产品在很大程度上依赖品牌和口碑来扩展更多用户。如果您的知识库页面——这些将用户带到您的网站并进而接触您品牌的页面——看起来像是来自别人的网站，那么您就会失去无缝网站体验所带来的可信度。

您应该能够将您选择的任何知识库提供商作为“白标”使用，这意味着没有突兀的品牌标识干扰。当然，这也意味着可以自定义页面的布局和配色方案，以与您网站的其他部分相匹配。

版本控制与差异对比

当快速软件原型设计和发布周期成为常态时，您会希望您的文档团队能随时做好准备。

毕竟，如果您推出了更新，而您的文档没有涵盖某个问题或新功能，您将恰好在错误的时机面对困惑和沮丧的客户。

您的产品文档软件应该允许您的撰稿人或团队能够一目了然地在当前版本的帮助文档与任何计划中的更改之间来回切换。

你还应该能够查看两个不同的版本（例如一个保存在纽约时间上午10:00，另一个保存在北京时间下午12:30），以了解不同的编辑如何处理相同的任务。

有了这些功能，你将能够保持井井有条，并且不必处理类似Google文档那样的问题——多个相互竞争的版本控制方案和时区让你的团队搞不清哪个版本是最新的。

分析功能

除了良好的用户体验，你也希望从中有所收获。仅仅托管一个知识库，你能得到什么？

你可以获得数据。

每个用户在访问或进行搜索时都会在你的日志中留下足迹，这些足迹可以随时间聚合，让你清楚地了解哪些文章最受欢迎，哪些文章需要改进，以及哪些文章的月浏览量恰到好处。

所有这些都应该在你选择的文档管理平台的后端可用。理想情况下，你还应该能够查看搜索栏的使用统计数据，例如每个独立访客的搜索次数以及总搜索量。

一个特别有用的数据点是“无效关键词”列表，即那些返回零文章结果的搜索。如果这些是拼写错误的单词，那没关系，但如果这些是与你的产品相关的关键词，那么你就知道需要加强文章创建以填补空白。

有了这些数据，您当然可以改进您的文档，但也可以将其作为客户可能在使用产品时遇到问题的一般参考。这是免费的用户体验测试和反馈数据！

试试Baklib吧！注册14天免费试用

立即开始

如何编写有效的SaaS文档

在我们结束之前，必须回顾三个关键原则，这些原则决定了您应如何在知识库中实际构建您的文章。

简洁明了

您的文档不是炫耀写作技巧的地方。优秀的技术写作应该是隐形的，因为它应该准确传达信息，而不会让读者注意到其风格。

这意味着您的文章都应该相当简短。作为一般规则，完成初稿后，尝试将字数减少大约百分之十。

快速阅读者和略读者会为此感谢您，使用第二或第三语言阅读的用户也会如此。

可操作性强

每篇文章都需要有效解决问题，或为用户的问题提供具体步骤，使其得到些许改善。

您可能认为这是常识，但实际上有很多人编写的文档只是其产品的变相广告，或是从其他地方照搬而来，未经过有效性的彻底审查。

使用清晰直接的语言，逐步引导用户完成他们需要做的事情。有些平台允许您在文章中放置流程图或嵌套说明，从而为在各种设备上使用您产品的用户定制体验。

保持更新

这甚至可能是最重要的原则！您应该努力使文章与软件的实际使用尽可能相关。

优秀的Baklib能让您轻松查看哪些文章最旧，并在可能时提醒您检查这些文章。您还应养成每年进行两到三次审核的习惯——如果发布周期较快，则应更频繁。

这些审核应涵盖知识库中的所有文章，并检查死链接、过时信息以及可能涉及旧版用户界面的照片或视频。

如此关注保持文档最新可能看似偏执，但请记住，您的客户每月付费是期望您持续为他们开发软件。保持文档达到相同质量标准是这份协议中不言而喻的一部分。

结论

总而言之，我们推荐Baklib来满足您的知识库需求。它具备功能部分提到的所有特性，并且以优雅的方式实现。甚至在可信的聚合网站上也获得了高度评价。

您可以参考他们自己的帮助台获取灵感，这是一个在组织和写作最佳实践方面的绝佳范例。如果您希望在自己的网站上实现类似功能，可以通过免费试用在十四天内体验全部功能！

您的客户值得最好的软件和最好的服务。使用优秀的知识库，您将能够两者兼得，无需妥协。

继续阅读： 流程文档入门指南