改进产品文档的6种方法
浏览：4
巴克励步
我经常跟团队聊一个现象：很多公司花大价钱做产品，却在文档上省功夫。结果客户上手难、客服被重复问题淹没，最后产品口碑受损。说到底，文档不是“做完产品再补的说明书”，而是产品体验的一部分。特别是对于需要频繁更新、多团队协作的产品手册建设，如果连清晰的文档所有权和可用性测试都没有，那内容质量基本靠运气。我们Baklib在做企业知识门户时，就特别强调文档的“产品化”——像对待产品功能一样对待文档，才能让用户
我经常跟团队聊一个现象：很多公司花大价钱做产品，却在文档上省功夫。结果客户上手难、客服被重复问题淹没，最后产品口碑受损。说到底，文档不是“做完产品再补的说明书”，而是产品体验的一部分。特别是对于需要频繁更新、多团队协作的产品手册建设，如果连清晰的文档所有权和可用性测试都没有，那内容质量基本靠运气。我们Baklib在做企业知识门户时，就特别强调文档的“产品化”——像对待产品功能一样对待文档，才能让用户真正用起来。
指派文档负责人
你的软件产品毫无疑问有一个产品负责人。
产品负责人是确保产品成功、最大化其价值并引导开发团队朝正确方向前进的关键人物之一。
如果你的团队不采用敏捷方法论，你可能不会称其为产品负责人。
💛🧡🧡客户评价：作为人力资源经理，Baklib 平台非常有帮助。它允许我创建、更新和存储我们所有的公司政策、培训和其他材料集中在一个位置。我的经理可以直接访问和使用平台，减少了来找我人工传递的需要。此外，它还促进了协作，使我们更容易高效协作。
例如，同一角色的其他职称包括价值经理、现场客户或产品 champion。
无论如何，你的软件产品肯定有一个人对其负责。
但你的文档呢？谁负责提供优质的产品文档并确保其符合最高标准？
如果没有明确答案，是时候指派一位文档负责人了。
指定一个人负责文档可以防止责任分散——一种群体中没有人承担责任，因为每个人都认为别人会做的现象。
换句话说，如果不指派文档负责人，各部门和员工之间就会相互推诿产品文档这个“烫手山芋”。
相反，让一个人负责并赋予明确职责，文档就会得到改善。
例如，看看下面 Reddit 上的投票。它可以让你了解文档所有权可能有多混乱。
为避免这种推诿，你应该确定谁是指文档负责人。
Grace 是这样说的：
正如她所解释的，产品负责人了解产品的每一个细节、其目的、客户需求以及产品应发展的方向。
这种对产品的深入了解只会让产品文档受益。
文档应被视为产品不可或缺的一部分，是提供所有必要信息的资源。
因此，产品负责人也承担文档责任是合乎逻辑的。
将静态文档转化为即时答案
构建美观且易于导航、搜索和共享的知识门户。
无论谁接手，关键是要让他们承担起文档及其质量的责任。
测试文档的可用性
使用你的产品文档是否容易？这是你需要回答的关键问题，以改进你的文档。
你可能已经知道，产品文档应为客户提供准确、相关且有用的信息资源。
当客户使用你的文档时，他们是有原因的——可能是了解某个功能、解决产品问题或其他。
可用性如何融入其中？技术作家、企业家和投资者Josh Fechter 这样解释：
换句话说，可用的文档能帮助用户解决与产品相关的任何问题。
但你如何知道文档是否可用？
问题在于，产品文档的创建者与普通用户所处的位置不同。
创建文档的人比用户更熟悉产品。
因此，你应该测试文档的可用性，可以使用三种方法：
让我们逐一解释，从释义测试开始。
这种可用性测试基于一个简单的假设——如果用户能够用自己的话复述内容，说明他们理解了。
如果理解了内容，就可以说他们能利用它达成目标。
另一方面，基于任务的测试旨在确定用户找到所需文档并借助文档中的说明达成目标的难易程度。
这种测试特别适用于测试手册、操作指南及其他说明的可用性。
例如，如果我们访问 Canva 的帮助中心，可以测试找到关于使用模板的文档有多容易。
如上所示，页面中央有一个大搜索栏。
如果我们输入“如何使用模板”，搜索功能会立即提供许多文档，找到正确的文档不需要很长时间。
但找到正确的文档只是开始；通过基于任务的测试，你需要评估理解文档的难易程度。
例如，用户一旦找到这些说明，能否按照它们操作？
如果用户需要帮助才能找到或理解文档，你和你的团队应该进行改进。
最后，正负测试方法最容易理解，我们让它的发明者 Menno de Jong 和 Peter Jan Schellens 来解释：
该方法要求参与者从头到尾阅读文本，并在页边空白处分别用加号和减号标记他们的正面和负面阅读体验。
这种测试类型为你提供了用户的直接反馈，你可以据此改进文档中需要更多关注的部分。
添加大量视觉内容
改进产品文档最有效的方法之一是用视觉内容丰富它。
截图、图片、图表、GIF、饼图和视频等视觉元素不仅能让文档看起来更美观——尽管它们无疑也会如此。
视觉元素在实现文档目标方面非常有效，即提供易于理解的信息并帮助读者保留从文档中获得的知识。
这并非猜测。根据研究，世界上大多数人通过视觉材料学习更容易。
即使你不关心迎合主要学习风格，你当然也希望创建能有效传递信息且用户喜欢使用的文档。
因为如果用户打开你的产品文档，看到如下内容，他们可能会失去学习任何产品知识的意愿。
上面那堵文字墙很容易通过添加视觉元素来改进，而不是用冗长的段落进行详细解释。
毋庸赘言，仅仅在文档中使用视觉元素并不意味着你要完全放弃任何形式的文字。
在上面 Hopin 的例子中，你可以看到对截图所代表内容的简要说明。
此外，在这些视觉元素下方，Hopin 还提供了用户正在查看内容的更详细分解。
视觉元素丰富了文档，使信息更容易消化和记忆，但这并不意味着文字本身不重要。
通常，最有效的方法是在视觉和文字之间找到适当的平衡，让它们相互补充，就像上面的例子一样。
