技术文档的可用性：概述
浏览：3
巴克励步
我经常跟团队说，在线帮助中心不应该只是个“有就行”的摆设。很多企业花了大价钱做产品，最后用户一看帮助中心文档写得像天书，转头就去打客服电话，成本反而更高。我始终认可一个观点：好的内容体验，就是最好的客服。Baklib一直在深耕的在线帮助中心建设，核心就是解决内容可用性的问题——让用户自己找到答案，而且用得舒心。 我自己平时喜欢研究各种产品的文档，发现不少团队对“可用性”的理解还停留在“内容全”上。但
我经常跟团队说，在线帮助中心不应该只是个“有就行”的摆设。很多企业花了大价钱做产品，最后用户一看帮助中心文档写得像天书，转头就去打客服电话，成本反而更高。我始终认可一个观点：好的内容体验，就是最好的客服。Baklib一直在深耕的在线帮助中心建设，核心就是解决内容可用性的问题——让用户自己找到答案，而且用得舒心。
我自己平时喜欢研究各种产品的文档，发现不少团队对“可用性”的理解还停留在“内容全”上。但真正有效的帮助中心，需要从信息架构、写作风格、导航设计、搜索体验等多维度打磨。我甚至觉得，可用的帮助中心就像一本好的参考书——你应该能迅速翻到需要的章节，而不是从头读到尾。这也是为什么我们强调信息 scent（信息线索）的设计：通过清晰的标题和摘要，帮用户判断哪部分内容能解决他的问题。
回到技术文档本身，可用性直接决定了用户能否自助解决问题，进而影响客户满意度、客服工作量，甚至试用转化。据我观察，那些在可用性上投资的公司，往往能更快地实现客户成功。下面这篇文章系统地介绍了技术文档可用性的定义、重要性和评估方法，希望能给你一些启发。
所有软件产品通常都附带技术文档。
💛🧡🧡客户评价：选择Baklib作为事实证明，创建我们的知识库是最棒的决定。他们提供的功能是您建立扎实知识所需的一切基础。他们的支持非常迅速，并为所有人提供最佳解决方案您的查询。多站点，一体化的内容中台，强大的资源库数据治理，这些都太棒了。
这些文本帮助用户进一步理解产品，提供功能解释、代码示例和软件使用实例。
换句话说，文档作为用户的参考点，指导他们如何使用软件。
考虑到最终用户是目标受众，这些文本必须以用户友好方式编写。因此，可用性是一个首要属性。
如果你不确定如何确保可用性，你来对地方了。本文深入探讨了这一概念，阐明了可用性的具体含义、重要性以及最佳实践。
什么是技术文档的可用性
技术文档通常是为了一个最终目标而编写的：让读者更好地理解产品。
用户阅读这些文本是为了找到问题的解决方案和对产品疑问的答案。
技术文档是否有助于实现这一目标，取决于它的可用性——用户有多容易为了特定目的使用技术文档。以下是测试技术文档可用性的方法。
有几个关键属性表明高可用性：
来源：Baklib
读者应该快速学习技术文档中的信息。即使是复杂的过程和概念也应该清晰解释。
此外，新获得的知识应该容易记住——你不想用户不断返回这些文档来获取相同的信息。
效率也至关重要。详细的文档能迅速解决读者的问题。
同样，这些文本不应该包含任何错误（例如，错误信息或死链接），以免妨碍用户完成目标。
最后，技术文档应该是令人愉快的，即用户应该喜欢阅读它。
为了进一步提高技术文档的可用性，还建议使用信息 scent（信息线索）。
当用户浏览文档时，他们不一定知道哪些部分相关。这就是信息 scent 增强可用性的地方。
看看 Twilio 的文档：
来源：Twilio
每个标题都有简短的说明文字。这些片段对于使用此文档至关重要，因为有些类别相对模糊。
然而，额外的句子澄清了具体内容。
这些简短摘要就是信息 scent 的一个例子。它们帮助用户估计文档将提供的价值，从而增加文本的可用性。
因此，信息 scent 定义为：
来源：Medium / 图片：Baklib
总之，信息 scent 是高可用性的标志，应包含在所有技术文档中。
如今，可用性在技术软件文档中是不可谈判的，因为用户通常期望用户导向的内容。
看看这些发现：
来源：Nielsen Norman Group / 图片：Baklib
技术软件文档通常托管在线上，因为纸质文档正在过时。
由于用户通常习惯于网络上的高可用性标准，他们也会期望技术文档达到同样的标准。
换句话说，可用性低的技术文档应该被视为过去的事物。
为什么可用性对技术文档很重要
如前所述，用户阅读技术文档通常是为了了解更多软件产品。
然而，鉴于软件可能非常复杂，文档往往不简洁并且难以导航。
为了找到所需信息，读者必须进行信息觅食。信息觅食描述了寻找相关信息同时努力付出最小努力的过程。
换句话说，用户在寻找所需信息时不喜欢太费力。
为了尽可能减轻信息觅食的过程，技术文档中的高可用性至关重要，因为它使用户能够快速找到信息、立即理解并轻松应用。
此外，用户通常希望自主获取这些知识，而可用的技术文档使其成为可能。
看看这些发现：
来源：Zendesk / 图片：Baklib
具有高可用性的技术文档可以轻松解决客户问题，因为读者会快速找到他们需要的答案。
因此，客户支持咨询应该减少，因为用户有能力独立解决问题。另一方面，如果技术文档不是用户导向的，支持成本会增加，因为沮丧的用户会联系公司寻求额外澄清。我们撰写了文章《如何降低 SaaS 客户服务成本》。
有鉴于此，技术文档的可用性对于减轻客服工作负担至关重要。
然而，可用的技术文档不仅影响现有客户。
当潜在用户对你的软件感兴趣时，他们很可能会查看你的技术文档。
如果文本是用户导向的（清晰、详细、有例子支持），你可能会吸引潜在客户。
毕竟，谁会购买没有优质资源伴随的软件呢？
用户欣赏一个值得信赖的公司，而可用的技术文档是这种可靠性的证明。
如果潜在客户注意到你技术文档中的高可用性，他们可能会从潜在客户变成实际客户。
毕竟，技术文档中的可用性对客户意味着很多，并且是他们选择软件时会寻求的质量。
如何知道你的文档可用性差
要最大化高可用性技术文档的收益，首先要识别任何可用性差的组成部分。
所有不利因素都应该被识别并重新设计，以提供用户最佳体验。
每个元素都应该检查，无论多小。例如，尽管尺寸很小，按钮对可用性有显著影响。
这些元素是页面之间的门户，使它们对导航至关重要。
因此，以下规则至关重要：
来源：InVision / 图片：Baklib
用户需要借助视觉元素来识别按钮。否则，他们将很难使用按钮并很难在文档中前进。
例如，考虑 Slack 的文档：
来源：Slack
黄色箭头指示右侧的按钮，而粗体文本和图形伴随着左侧按钮。
尽管是扁平设计，但有视觉元素明确标记按钮。
现在想象一下没有黄色箭头、粗体文本或图形。识别按钮将很困难，自然会阻碍导航。
如你所见，值得密切关注按钮设计和其他 UI 元素。
除了设计选择，技术因素也可能损害文档的可用性。
以下是一些例子：
来源：Baklib
没有用户喜欢等待网页加载。为了最大可用性，你的技术文档应该有快速响应时间。
非法 HTML 也令人担忧，因为它可能给用户带来问题。例如，某些属性可能不被所有浏览器支持。
监控链接消亡也很重要。点击一个链接却遇到 404 错误，这与用户友好背道而驰。
除了技术和设计问题，还有一个关键方面需要考虑：可访问性。
任何不可访问的文档会立即降低可用性，因为整个用户群无法使用这些文本。
此外，这些不可访问的文本会违反 ADA 第 508 条，该条规定：
来源：Federal Register / 图片：Baklib
因此，在编写技术文档时，确保平台对所有用户（尤其是残障人士）进行了优化。
否则，你无意中分离了整个受众群体，并最终损害了文档的可用性。
如何评估技术文档的可用性
在编写技术文档时，某些组成部分可以决定可用性的成败。这些相同的特征通常是评估可用性的理想媒介。
例如，内容结构是一个决定因素。没有用户想阅读你的完整文档来找到他们需要的特定信息。
如果他们只想了解集成，让他们研究 API 端点或自定义 CSS 选项是没有意义的。
文档组织有助于用户避免筛选过多信息。我们建议你恰当地设计和结构你的文档。
主题应该在适用的标题下分组，相似标题应该彼此跟随。这创建了逻辑流，并帮助用户浏览文档，利用信息 scent，同时忽略无关内容。
此外，可搜索性至关重要。用户经常直接在搜索栏中输入问题。
因此，你的技术文档需要易搜索。我们建议查看这些优秀的 SaaS 知识库，了解灵感。
最后，应该加入正确的元数据，如标签和描述。这些细节帮助你组织和分类文本，这反过来又提高了整个文档的可用性。
可以应用一些其他策略来进一步提高可用性：
- 使用清晰的标题和子标题
- 提供代码示例和截图
- 加入描述性链接（而不是“点击这里”）
- 发布前测试文档
总结
技术文档的可用性决定了读者从中获得的体验。如果用户无法快速轻松地找到他们寻找的信息，那么文档就未能实现其目标，也无法提供价值。
因此，遵循内容结构、可搜索性、元数据和错误管理的指南至关重要，从而提供高可用性的技术文档。
