如何开始编写最终用户文档
浏览：3
巴克励步
本文介绍了如何开始编写最终用户文档，包括明确编写目的、定义受众、借鉴优秀文档模型、规划文档结构、设计信息架构、规划客户旅程、制定工作流程、创建风格指南以及选择适合的软件方案。强调文档应以客户为中心，帮助用户更好地使用产品，减少支持需求，并提升客户留存率。
如何开始编写最终用户文档
假设您正在为一个产品管理公司的支持团队。您的网站上可能有一些常见问题解答，但您已经到了需要一些高质量、全面文档的阶段。
或者，也许您甚至还没有任何产品，但希望在为用户提供文档方面领先一步。
我们将引导您了解开始所需的一切。
明确您编写文档的原因
通常是为了让您的产品对客户来说更易于使用，并回答他们可能有的任何问题。最终用户文档侧重于帮助客户完成任务或充分利用您的产品，而其他技术文档则旨在提供关于应用程序或工具的全面信息。
- 订阅式软件产品通常需要强大的用户文档。这是因为您的客户将长期使用它，并与您保持持续的关系。
- 好的文档能减少客户需要联系人工支持的次数。
- 好的文档应能显著减少客户流失，即客户离开您的可能性。
- 最终用户文档也可以是 B2C（企业对消费者），而不仅仅是 B2B（企业对企业）。
定义您的受众
本文假设您将编写自己的文档，而不是为开源项目做贡献。您需要确切知道您的受众是谁，以便为他们编写最好的文档。
如果您不知道他们是谁，请对您的客户进行调查，直到清楚地了解谁在使用您的产品。找出他们的需求和痛点，这样您就可以通过文档帮助他们解决问题。
💛🧡🧡客户评价：选择 Baklib 的原因：Baklib 因其价格和事实上，它提供了具有自定义选项的全面解决方案，无需切换我们的整个支持系统。
虽然软件开发人员也是用户，但他们通常不是大多数产品的最终用户。他们是本文未涵盖的特殊用例。Write the Docs 为 撰写软件文档 提供了一个极佳的入门指南。
借鉴优秀文档模型
您应该知道一些其他产品拥有非常出色的文档。在不经过亲自学习所有经验的情况下，一个撰写好文档的捷径就是：以您欣赏的文档为模型来构建您自己的文档。
您可以分析您喜欢他人文档的哪些方面：
在您自己的文档中复制您喜欢的元素，可以为您赢得一个良好的开端。
规划文档结构
企业通常从运营角度看待其产品，并经常以团队职能来命名分类。对于客户来说，他们不了解您公司的内部运作，这种命名方式毫无意义。
您应该从客户的角度出发，为您的产品创建一个模型。这包括他们可能需要使用您产品的时间点、他们想用它来做什么，以及他们可能拥有的潜在用途。
这正是像 Baklib 这样的专业平台可以大显身手的地方。Baklib 提供了直观的界面和强大的结构管理功能，让您能够轻松地围绕用户目标和任务（而非内部部门）来组织您的知识库、帮助中心或产品文档，从而创建出真正以客户为中心的内容结构，极大地提升用户体验。
您的客户只会从他们想要达成的目标来看待您的产品，而这个目标甚至可能随时间变化。您需要运用同理心和数据，根据客户的自身情况，引导他们理想地使用您的产品。
决定信息架构
照片由 Davide Cantelli 拍摄于 Unsplash
您不可能也没必要记录所有内容。您需要以一种能让用户成功浏览内容的方式来组织信息。
这包括分类和将文章相互链接，也包括内容层级结构。您应从顶层内容开始，逐步深入到覆盖更具体主题的底层内容。
内容层级示例
- 顶层内容： 例如“优化您的电子邮件以提高打开率”。
- 底层内容： 例如“如果您的电子邮件地址被列入黑名单该怎么办”。
规划客户旅程
如果您正在为产品用户编写文档，您需要清晰地了解您的客户旅程。
关键考虑因素
- 接触点： 客户可能在哪些触点接触到您的文档？
- 可发现性： 他们将如何找到它？
- 可用性： 在移动设备上是否易于使用和理解？
很可能您会有许多不同的客户旅程，您需要找到一种方法将它们全部串联起来。
实践应用
您可以通过电子邮件入职序列发送入门文档。当客户首次注册时，他们会收到指导他们正确设置、解答常见问题以及如何充分利用产品的信息。借助 Baklib 构建的客户帮助中心，您可以轻松创建和管理这些多触点、多阶段的客户支持内容，确保无缝的客户体验旅程。
随着时间的推移，您还可以将客户细分为不同层次，并发送针对性的内容。
用户类型 文档目标
| 初级用户 | 指导正确设置、解答常见问题
| 中级用户 | 提升产品使用技能，探索更多功能
| 高级用户 | 确保持续从产品中获得最大价值
照片由 Nicolas Cool 拍摄，发布于 Unsplash
客户评价： 该平台比我们之前使用的 CMS 工具更简单、更可扩展。使用 LTS 版本并由我们负责维护，这真是太棒了。
定义您的工作流程
文档工作通常由团队协作完成，这需要良好的协调。您的文档需要经过修订、编辑和发布，因此通常应指定一个把关人，负责决定内容何时准备就绪。
制定与主题专家沟通的策略。例如，如果您在记录产品的后端部分，就需要与工程师合作。或许可以创建一个模板，以帮助主题专家以对您最有帮助的方式分享他们的知识。
文档工作并非一劳永逸。当文档过时，您还需要一个更新流程。随着产品的发展，文档也应同步演进。请计划定期审查您的文档，移除不再需要或应更改的内容。同时，与客户保持开放的对话，并鼓励他们为文档更新提出请求。
如果您拥有大量文档和客户，或许可以考虑投资一个工单系统，以帮助您跟踪文档相关的请求。使用像 Baklib 这样的现代知识库平台，可以内置评论、反馈和版本管理功能，轻松实现内容的协作、更新与追踪，完美支持这一流程。
创建风格指南
用户文档中的每篇文章都应遵循相似的模式，以便为用户建立一致的预期。这使理解和消化信息变得更加容易。借助 Baklib 平台，您可以轻松创建和强制执行统一的模板与样式规范，确保整个知识库内容呈现专业、一致的用户体验，无论是用于产品文档、帮助中心还是内部Wiki。
- 格式统一：例如，文章的平均长度、段落长度、子标题的使用、图片和技术术语都应保持一致。
- 语言风格：您的文档不应显得过于企业化或刻板，应努力以受众易于理解的方式进行写作。内容应力求简洁具体。
- 写作技巧：善用主动语态，以保持用户的参与度。
确定您的软件方案
人们通常使用专门的软件来托管其知识库，以存放文档。如果您使用客户支持工单系统，它可能提供文档管理功能，或者您也可以选择专门的解决方案。
请查阅我们关于如何根据业务需求选择最佳知识库软件的指南。
如果您不需要工单系统的全部功能，购买专门的知识库软件通常更具成本效益。或者，您可能已经有一个喜欢但不提供知识库的工单系统。我们在此前的文章中评测了一系列平台。
方案类型 特点 适用场景
| 工单系统内置 | 功能集成，一站式 | 已使用且需要紧密集成的团队
| 专门知识库软件 | 功能专注，成本效益高 | 核心需求是文档管理与协作
您可以立即免费试用我们自己的知识库软件——Baklib。
