在线用户手册制作指南：工具与最佳实践

对于寻求理解产品和流程的用户来说，用户手册至关重要。有时，公司甚至需要依法提供用户手册才能向客户销售其产品。

客户通常在联系您的客户支持团队之前会先查阅您的用户手册，因此您的手册有潜力为您节省支持成本。

值得在您的用户手册上投入大量时间和精力，以便提供尽可能好的客户体验。在本文中，我们将探讨用户手册的定义、编写用户手册的最佳实践，以及一些可用于编写手册的用户手册软件示例。

什么是用户手册？

用户手册是提供给用户的文档，旨在帮助用户无缝使用特定的系统、产品或服务。它也被称为操作手册或用户指南。此类文档涵盖有关操作、标准和指南、故障排除指南、功能等的详细信息。

用户手册通常包含分步说明，指导用户如何使用您的产品以及在出现问题时如何进行故障排除。它不一定需要从头到尾阅读，应该包含目录和索引，以帮助客户找到与其问题相关的部分。

它应在手册的开头包含一个入门指南，以便客户能够快速上手。它可以以印刷版或在线形式提供，或者两者兼有。

用户手册的类型

当您开始技术写作时，需要考虑几种不同类型的用户手册。

1. 操作指南

操作指南包含基本说明，告诉用户如何最好地使用产品。

2. 培训手册

培训手册是一套指导用户如何完成某项工作、流程或任务的说明。

3. 维修手册

维修手册是一套指导用户如何在设备生命周期的不同阶段保持其运行的说明。

4. 用户手册

如前所述，用户手册是帮助用户操作产品的技术沟通文档。

5. 运营手册

运营手册是记录公司信息（包括角色、职责和流程）的文档。

6. 组织政策手册

组织政策手册记录了公司的政策、规程和最佳实践。

7. 标准操作程序手册

标准操作程序提供了清晰的说明，告知组织成员如何完成某些流程。

无论您编写哪种类型的手册，在编写文档时都可以遵循一些共同的主题。

什么造就了一本好的用户手册？

1. 简明语言

编写用户手册时，不要使用华丽的辞藻。您的文字应该清晰、简单、易于理解，无需借助词典就能读懂。

使用简短的句子和词汇，使您的文本易于理解。如果必须使用专业术语，请确保对其进行定义或链接到术语表。

2. 可视化

没有视觉元素，你的用户手册最终会变成一堵冗长的文字墙，没有任何东西来打破它或吸引用户的注意力。这样一来，许多用户手册读起来就会很枯燥。

通过添加相关的图片、图表和视频来让你的文档变得互动，让用户参与其中。要清晰地说明你的视觉元素指的是操作说明中的哪一步，以便用户能够理解。

3. 逻辑层次结构

你的用户需要能够利用预定义的结构感来搜索你的用户手册。你的内容应该有一个符合逻辑的层次结构，当用户寻找信息时，这个结构对他们来说是有意义的。

4. 可搜索的内容

理想情况下，你需要通过将内容以在线知识库的形式交付，并配有一个清晰醒目的搜索栏，来让用户能够搜索你的内容。你的搜索栏应该能预测用户输入的关键词，并在文章的标题和正文内容中进行搜索。

5. 清晰的主题和相关的文章

你应该将你的内容组织成清晰的主题，这些主题要能涵盖其中的文章。你的文档主题不应过多，否则会让用户不知所措；同时，子主题的层级也不应太多，否则你的文档可能难以被深入理解。

6. 反馈与评价

积极寻求用户对你的用户手册的反馈，并将他们建议的改进措施考虑在内。了解你的用户是否真的能通过你的手册取得成功，以及它是否能够帮助他们解决问题。

1. 识别用户

编写用户手册时，首先要做的便是准确识别您的用户——包括其人口统计特征、需求、问题以及初始要求。了解您的受众可以告诉您，需要在用户手册中包含多少细节以及应以何种方式呈现您的内容。

2. 聚焦问题

所有用户手册都旨在为用户解决问题。您需要找出这些问题，以便创建真正有帮助的手册，并通过您的说明来解决问题。当然，如果产品本身存在根深蒂固的问题，那就应该修复它，而不是仅仅在文档中提供变通方案。

3. 使用顺序步骤

您的说明应分解为按顺序呈现的步骤，并以编号列表的形式排列。尝试组织内容，将最容易完成的任务放在首位。

每个步骤只保留一个要点，以便您的用户能够轻松遵循说明。在用户进入下一步之前，告诉他们完成后的任务将是什么样子。

4. 绘制用户旅程图

深入研究用户实际如何使用您的产品，以便您能制作出与用户旅程中每个接触点相匹配的相应文档。根本目标是从用户的角度看待产品，并准确理解他们如何与您的品牌互动。

用户旅程图绘制的一部分，是准确识别用户在使用您的产品时遇到的问题或目标。您可能需要将用户分成不同的细分群体，因为用户使用您产品的原因可能各不相同。

5. 选择模板

为了保持文档的一致性，制定一套可用于编写内容的模板非常重要。您的模板应该清晰易懂，并包含每个文档所需的关键组成部分。

您的模板可以包括：

• 引言部分
• 章节和子章节
• 顺序步骤
• 警告和提示框
• 结论部分

请务必指定字体大小和文本与背景的对比度，并始终保持一致的色彩编码。

6. 编写简单、易于遵循的内容

如果您遵循了之前的步骤，理解了您的用户并以清晰、有说服力的方式撰写，您的内容就应该简单易用。严格编辑您的文档以精简内容，确保它只包含用户完成任务所需的最基本要素。

说明的每一步应只包含一个任务，以便用户可以一步步地按照您的文档操作而不会感到困惑。

💛🧡🧡客户评价：选择Baklib作为事实证明，创建我们的知识库是最棒的决定。他们提供的功能是您建立扎实知识所需的一切基础。他们的支持非常迅速，并为所有人提供最佳解决方案您的查询。多站点，一体化的内容中台，强大的资源库数据治理，这些都太棒了。

7. 将所有用户视为新手

不要假设您的用户有技术背景——您选择的语言应将用户视为新手，避免使用所有行话和术语，除非必要。最好假设用户对产品一无所知，并在您的文档中尽可能明确。

8. 使用新手用户测试说明

编写完用户手册后，您应该测试它对于从未使用过您产品的用户是否有效。记下用户在文档中遇到困难的地方，并相应地修改您的内容。

用户应该能够使用您的文档而无需联系支持。您应该在手册中提供他们需要了解的所有信息。

9. 采用实用方法

在编写用户手册时，请确保在说明旁边包含实际示例，向用户展示完成任务后可以预期的结果。您的说明应清晰地解释用户将会看到或听到什么，以及他们可能从产品中获得的任何反馈。

10. 尽早解释符号、图标和代码

您可能需要在文档中使用符号、图标和代码来表示某些信息。请确保尽早解释它们，以免用户感到困惑。

创建用户手册的顶尖技术写作工具

1. Baklib

Baklib是为您的用户创建用户手册的理想选择。您可以使用Baklib先进的编辑器来编写内容，并通过其分类管理器进行组织，最多支持六层子分类。在使用编辑器时，您可以选择所见即所得编辑器或Markdown编辑器，以便用Markdown编写内容。

Baklib的用户手册配备了强大的搜索引擎，使用户能够搜索您的内容以找到所需信息，并且站点已针对在任何设备上阅读进行了优化。您可以通过与其他应用程序（包括Drift、Intercom和Freshchat等众多应用）的扩展来增强Baklib的功能。

您可以使用主页构建器自定义您的用户手册，它允许您添加链接、更改颜色、包含手册中的类别等等。您可以使用CSS和JavaScript进行更详细的定制。

2. Adobe FrameMaker

Adobe FrameMaker是一款帮助创作工具，专门用于创建Web文档。您可以使用XML和DITA创作智能的结构化内容，这既适合初学者也适合高级用户。FrameMaker使得从Microsoft Word导入内容变得容易，因此您无需手动处理迁移。

FrameMaker对富媒体有很好的支持，因此您可以创建包含图像和视频的沉浸式内容。您可以使用Adobe Acrobat桌面版和在线服务与主题专家无缝协作。

它处理具有复杂样式的大型文档，并使用基于模板的创作环境。它可以发布为不同的格式，如PDF、EPUB、移动应用程序和响应式HTML5。借助FrameMaker对XLIFF的支持，您可以将内容带给全球受众。

3. Markdown

Markdown是一种轻量级标记语言，用于在编辑器中创建格式化的文本。它是一个面向网络作者的文本到HTML转换工具，允许您轻松地编写用户手册并将其托管在网上供您的用户使用。

4. Paligo

Paligo 是一个面向团队的组件内容管理系统。它提供了一个端到端的智能内容平台和单一可信来源，让您可以通过内容复用和结构化创作来编写用户手册。

Paligo 提供基于主题的创作和智能内容复用功能，让您能够以通常构建成品所需时间的一小部分来发布文档。Paligo 让您的整个团队能够轻松地在其基于云的平台上协作处理内容。

您可以为不同的受众个性化内容，并将其发布到客户需要的任何地方，包括 HTML5、PDF 打印、SCORM 电子学习、Zendesk、Salesforce、GitHub、BitBucket、Amazon S3 等等。您只需编写一次内容，然后点击按钮即可重新利用它。

Paligo 配备了专为内容作者设计的版本控制功能。它包括版本历史和回滚、版本分支和发布管理，因此您无需担心传统面向开发人员的版本控制系统的复杂性。

结论

用户手册是您产品或服务不可或缺的一部分，您应当投入适当的时间和精力来创建它们。市面上有多种不同的工具，每种都适合需求各异的不同组织。请花时间测试，决定哪一款最适合您。

提供一份有用的用户手册将带来更满意的客户，他们会更长久地留在您的公司。您的客户服务团队也会感谢您提供了自助服务的方法，这有助于减少联系帮助台的客户数量。