一份确保顶级产品手册的简单清单

作为Baklib的研究员，我经常看到一些团队花大把精力打磨产品，却把产品手册当作应付差事——随便写写、版本混乱、用户根本找不到重点。这其实是在浪费客户信任。真正好的产品手册，应该像产品的无声客服，不仅说明功能，还要引导用户快速上手。而这正是“产品手册建设”的核心：用结构化、可检索、易更新的内容，把产品价值传递出去。Baklib的多站点发布和多格式支持，恰好能帮团队摆脱文档散落、协作低效的困境，让产品手册真正成为用户体验的加分项。

在当今软件市场，优秀的产品手册是不可妥协的。

它充当了企业与客户之间的桥梁。

它提供关于产品或服务的所有必要信息，是一种推广工具，鼓励客户深入探索产品的功能等等。

简而言之，你很难找到一家企业不会从顶级产品手册中受益。

在本文中，你将学习如何通过几个基本技巧来创建它。

让我们开始吧！

一个想要为其产品制作高质量文档的企业，不应将写作过程交给运气。拥有风格指南可以确保这一点不会发生。

当技术写作者拥有风格指南时，他们就有了一个提供如何创建文档的说明的资源。

这意味着每位写作者制作的每份文档都将保持一致。

但这并不意味着文档必须刻板、无聊或没有人性。

经验丰富的沟通者 George Lewis 解释说，其目的是简化创建文档的过程。

但“定义语言”在产品手册的语境中意味着什么？

其中一点指的是公司风格和品牌。例如，Mailchimp 有一个风格指南，指导员工如何撰写关于公司的内容。

如上所示，这包括例如如何拼写公司名称，随着时间的推移而改变。

此外，风格指南对于与客户建立联系也很重要，正如产品内容专家 Nicola Evans 指出的那样。

换句话说，风格指南让你能够更有效地与客户沟通。

为什么？让我们再看看 Mailchimp 的例子。

它是一个面向小企业的营销平台和电子邮件营销服务，拥有数百万客户，正如他们的团队所指出的。

因此，他们可以假定产品手册的受众很广泛，来自不同行业，具有不同水平的技术知识。

这就是为什么他们指导写作者撰写清晰、有用、友好且合适的内容。这一切都是为了尽可能覆盖更多的读者。

Mailchimp 的风格指南还涵盖其他主题，如格式化、结构化内容、标准化拼写等。

然而，重点不是你必须复制他们的理念和对待客户的方法。

你最了解你的受众，所以只需以一种对他们最有效的方式写作，并依赖风格指南来确保你的文档在形式和质量上保持一致。

顶级产品手册的特点之一是易于导航。

这意味着它可以帮助客户，而获取有用的信息正是客户首先求助于产品手册的原因。

目录对于使文档易于导航至关重要。

它基本上是文档中可用信息的鸟瞰图，包含每个部分的标题和页码。

然而，由于如今SaaS企业的产品手册几乎完全在线，目录看起来有些不同，而且更重要的是，功能更强大。

怎么做？除了列出文档的内容，让客户快速浏览并查看是否能找到他们需要的信息外，你还可以将标题变成链接。

例如，Shopify 在其左侧有一个整个文档的目录，以及每个文档页面的特定目录：

这样一来，读者只要打开页面就能看到他们要找的信息是否在该页面上。

特定页面的目录不一定要像 Shopify 那样放在最显眼的位置。

例如，你可以将其放在正文的任一侧。

看看下面 Dashlane 文档的例子。目录在右侧。

当然，它是可点击的，因此用户的导航尽可能简单，这极大地提升了文档的整体质量。

另外，值得一提的是，Dashlane 的目录始终保持在屏幕上。例如，你可以向下滚动到第三步，目录仍然可见。

正如你所见，在查找信息时，目录可以成为产品手册中非常有价值的元素。

为了确保你的文档达到最高标准，请务必包含它。

正如我们在上一节中提到的，你组织信息的方式对于确保你的产品手册真正出色至关重要。

如果你接受我们的建议，为文档添加了目录，那么标题也应该跟上。

标题是让文档对受众更具可读性和可访问性的好方法。

本质上，它们将长文本分割成更小的部分。

例如，你可以使用标题将文档划分成主要部分，然后在这些部分内部使用子标题将文本进一步分割成更小的部分。

下面，你可以看到 Dropbox 文档中的一个例子。

正如你所见，该部分涉及更改和重置密码。

文档的格式是，在一个主要标题下，有三个子标题。

一个提供了如何从登录页面重置密码的说明，另一个介绍了如何从设置中重置，最后一个部分是关于更改密码时可能遇到的问题。

使用标题和子标题格式化你的文档可以显著提高其可用性——想象一下，如果没有它们，上面的文本会是什么样子。

是否可读？当然，如果写得好的话。

然而，用户将更难导航并找到他们需要的信息，除非从头到尾读完。

但受益于使用标题的不仅仅是读者。正如技术写作专家 David McMurrey 所说，文档也有助于写作者组织他们的工作。

标题和子标题通过一次专注于一个主题并在文档内建立层次结构，使写作更容易。

因此，一个宽泛的主题，比如更改密码，可以被解析成几个更小的元素。

所有这些都使作者更容易组织他们的写作，从而帮助读者更容易地跟随和理解。

阅读产品手册并不是最令人兴奋的活动。

你可能拥有出色的写作技巧，但事实是，读者来阅读产品手册是为了解决问题或了解产品，而不是为了从阅读中获得乐趣。

产品手册有明确的目的，如果你想创建顶级文档，你应该不惜一切代价实现它。使用说明性图片可以帮助你实现这一目标。

怎么做？通过快速清晰地传达信息。

看一眼图片，读者就能在阅读文字解释所需时间的一小部分内获取信息。

这也是经验丰富的技术写作者和博主 Tom Johnson 大力支持在文档中使用视觉元素的原因。

快速传达信息的重要性不应被低估。

正如我们所说，用户浏览产品手册是为了找到他们需要的特定信息，这通常意味着他们不想阅读超过必要时间的内容。

---

💛 🧡 Baklib 是一个快速网站应用程序开发平台。这意味着我们基于低代码/无代码应用程序开发方法进行构建，从而使 Baklib 能够数字化和优化业务流程和用户界面。从本质上讲，我们的企业应用程序开发平台由两个具有类似功能和方法的模块组成。Baklib 的SaaS版本和私有化两种版本都能够加快企业应用程序开发、代码可重用性和紧凑的变更管理。我们的方法是，两个版本的 Baklib 既提供领先的集成和可扩展应用程序开发的中央平台。Baklib 使用量身定制的工具集将 IT 部门转变为“网站应用程序工厂”。这使得公司能够利用其现有的开发人员技能和工作方式，而无需进行密集培训或技能提升，从而使企业应用程序开发速度提高 10 倍。通过提供现成的应用程序模板和应用程序构建块，IT 可以轻松实现应用程序开发的工业化，轻松快速地推出应用程序。Baklib 在其平台中结合了无代码、低代码和专业代码工具，为企业 IT 部门提供了一套全面、互补的工具集，以满足从后端、全栈/前端到平民开发人员的不同角色的需求。这消除了文化和工作流程鸿沟，并通过使用适当的技术将业务和 IT 连接起来，帮助拉近团队之间的距离。