什么是应用软件用户手册以及如何编写
浏览：1
巴克励步
我最近在帮一个SaaS团队梳理产品文档，发现他们花大量时间回答用户关于基础功能的重复问题。团队Leader抱怨说，用户手册写得很糟糕，用户看不懂，客服疲于奔命。这让我想起产品手册建设的一个核心逻辑：好的手册不是把功能罗列一遍，而是让用户自己找到价值。今天聊聊应用软件用户手册怎么写，才能既帮用户上手，又解放团队。 什么是应用软件用户手册你上次遇到不带用户手册的软件是什么时候？现在几乎没有不带用户指南的
我最近在帮一个SaaS团队梳理产品文档，发现他们花大量时间回答用户关于基础功能的重复问题。团队Leader抱怨说，用户手册写得很糟糕，用户看不懂，客服疲于奔命。这让我想起产品手册建设的一个核心逻辑：好的手册不是把功能罗列一遍，而是让用户自己找到价值。今天聊聊应用软件用户手册怎么写，才能既帮用户上手，又解放团队。
什么是应用软件用户手册
你上次遇到不带用户手册的软件是什么时候？现在几乎没有不带用户指南的软件产品了。这背后有很好的理由：软件产品很复杂，无论是普通用户还是开发者，都需要一份涵盖安装、使用和故障排除的手册。正如知识管理专家 Brayn Wills 所说，应用软件用户手册是包含所有产品信息的全面资源。
在线用户手册是一个一站式平台，客户可以在几秒钟内找到所有产品或服务相关信息。
优秀的用户指南能帮助用户熟悉应用并发挥其全部潜力。因此，它应该包含一些关键要素：
💛🧡🧡客户评价：我喜欢 Baklib 能够导入我们来自Zendesk的知识库文章，没有任何问题。很容易分类，版本控制，设置过期时间，并使用Baklib向特定组或用户群体公开内容。搜索引擎使用自然语言，因此结果始终相关。Baklib易于实施，在我试用期间，客户支持团队为我设计了我的网站界面，使其看起来非常像我们面向客户的网站。我们每天都使用Baklib为我们的IT团队记录解决方案。Baklib可轻松与任何身份提供商集成，这使我们能够使用SSO没有问题。
- 入门指南
- 分步说明
- 故障排除部分
我们来看一个例子。热门的用户行为分析工具 Hotjar 就有一份符合所有条件的手册。例如，他们的“入门”部分涵盖了所有基础功能的说明。新用户可以通过它熟悉应用及其基础知识。说明部分是手册的关键——尤其是呈现方式。即便说明面向的是像软件开发者这样更懂行的用户，这点也很重要。例如，Hotjar 在安装跟踪代码时，提供了手动添加代码到网站的分步说明。此外，手册还应该包含故障排除部分。使用软件产品并不总是一帆风顺。Hotjar 团队为此准备了常见安装问题的解答资源，这样用户就能自行解决问题。总结一下，应用软件用户手册是一份重要的文档，它确保用户拥有正确使用应用所需的所有知识。
为什么你应该编写用户手册
为应用编写一份出色的用户手册，不仅对用户有利，也对你的公司有利。对用户而言，手册帮助他们从应用中获取价值。用户越早知道应用的功能、如何使用它们以及如何最大化产品的价值，他们就越能意识到产品的重要性。而看到产品价值的用户没有理由放弃它。用户是否可以通过其他方式了解你的应用？当然可以。例如，他们可以向客服提出几十个问题。然而，大多数用户更喜欢自己学习。数据也支持这一点。根据《哈佛商业评论》，81% 的客户在所有行业中更愿意先自行解决问题，然后再联系人工客服。关于对公司的好处，它们源于用户使用出色自助知识资源时获得的良好体验。更具体地说，用户手册减轻了客服团队的压力。当有了详细的资源后，客服无需重复回答相同的问题，浪费时间去解释基础功能，而是可以专注于需要全力处理的复杂问题。如果你有一份像 SurveyMonkey 那样详尽的手册，用户可以满足几乎任何信息需求。看左侧的目录，它有十个内容类别，每个类别下还有子类别。例如，“创建调查”部分有 11 个子类别，而且还不止这些。每个子类别都包含多篇文章。例如，“设计调查”有 12 篇文章。有了这么多信息，用户可以了解产品、找到问题答案并从产品中获取价值——这些都是编写用户手册的绝佳理由。
如何编写应用软件用户手册
现在我们已经明确了什么是应用软件用户手册以及为什么你应该投入时间和精力去创建它，接下来我们仔细看看编写过程。与任何这样规模和复杂度的任务一样，编写用户手册也有步骤，遵循这些步骤可以最大化创建有价值资源的机会。以下是如何编写技术手册：
1. 规划用户手册
编写用户手册是一项详细且大型的项目。如果你想创建一份能为读者传递知识的资源，应该细致地规划它。对手册的规划越详细，它最终实现教导产品、使用方法和潜在问题解决方案这一目的的机会就越大。因此，在动笔之前，你应该考虑以下事项：
- 要包含哪些信息？
- 如何组织这些信息？
- 谁负责创建、审核和维护手册？
- 应该准备并使用哪些视觉元素？
回答了这些问题，就已经向高质量用户手册迈出了一大步。要回答这些问题，你需要确定受众并了解他们的需求。例如，软件开发者比普通用户有更高的技术知识水平，因此对手册内容的需求也不同。他们可能不需要关于如何登录应用的详细说明，但会从 REST API 每个端点的详细信息中受益。除了手册内容，你还应该规划其交付方式。例如，你可以参考下面 Reddit 用户的建议。另一方面，你也可能决定使用不同于编号列表的方式来提供说明。关键是，你应在编写之前就规划好。这样，你的编写过程才会顺畅，并且能创建出高质量的软件文档。
2. 结构化文档
制定好手册计划后，下一步就是构建其结构。良好的结构对于文档的实用性至关重要。内容应有逻辑层次，以便读者直观地跟随并快速访问所需信息。例如，手册的逻辑结构应该是先讲基础用法，再讲高级功能。看看下面 Asana 用户手册的例子。左侧有目录，“基础”部分在顶部，这意味着读者应该先看基础部分，然后再阅读像项目、权限、API 等更高级的功能。像上面看到的目录是确保手册易于导航的绝佳方式。当然，要拥有目录，你应该使用标题和子标题来格式化手册。例如，Asana 手册中的类别用标题表示，每个子类别在目录中是子标题。你看到，“任务”标题下的一个子标题叫“任务操作”。该小节有自己的子标题，读者可以点击。这样的结构使得导航手册更容易，尤其当手册内容量很大时。还有一点影响用户手册实用性的是你的写作方式。我们下一节再详细讨论。
3. 使用简洁语言
没有什么比用户无法理解手册更让手册无用的了。如果你的写作方式让读者需要字典和高级搜索才能读懂手册，那肯定会让用户感到沮丧并疏远你的产品。解决方案是使用简洁语言。以下是技术作者兼语言学家 Joe Devney 的一些建议。换句话说，高质量的应用软件用户手册应该能被更广泛的受众理解。写作应该清晰易懂，尽可能少用技术行话和复杂术语。然而，由于用户手册是为软件产品编写的，你很可能无法完全避免使用技术术语。这完全没问题，只要你引入时定义它们，或者创建一个术语表供读者查阅。例如，Apple 为 Final Cut Pro 软件创建了详尽的术语表。
