有关如何创建和管理产品文档的分步指南 | 产品管理#31

已发表: 2023-10-02
产品管理不仅仅是创造新功能或优化现有功能。 这还包括创建产品文档，这对于用户有效使用产品并解决他们可能遇到的任何问题至关重要。 那么这样的文档应该包含哪些内容呢？ 阅读我们的文章并找出答案。

产品文档 - 目录：

  1. 什么是产品文档？
  2. 如何创建产品文档？
  3. 发布和分发产品文档
  4. 概括

什么是产品文档？

产品文档是描述产品、其功能、使用方式以及其他相关细节的文本、视觉效果和视频的集合。 创建文档的主要目的是帮助用户了解如何使用产品，尤其是其高级功能。

文档非常重要，尤其是当您创建的数字产品不仅可以为最终用户提供服务，还可以与其他产品集成时，例如，允许您将数据导出到另一个应用程序，或者使用本地化或联系人数据库。

例如，项目管理工具的文档可能包括有关如何创建新项目、如何将团队成员添加到项目并授予他们仅更改某些任务的权限、如何同时将任务分配给多人以及如何跟踪他们的进展。

产品文档的要素

产品文档可能包括：

  • 用户手册– 提供有关产品功能、安装、设置和故障排除信息的文档。
  • 用户指南– 解释如何使用产品执行各种任务的文档，例如如何使用照片编辑程序或如何玩电脑游戏。
  • 知识库——回答常见问题或提供有关产品的附加信息的文章或网页的集合。 一个例子是网站上的“帮助中心”或“支持”部分。 它还经常被用作帮助客户的聊天机器人的信息来源。
  • 常见问题解答– 有关产品的常见问题和解答列表。 例如，包含以下问题答案的网站或 PDF 文件：“如何重置密码？”、“如何联系客户支持？” 或“产品的系统要求是什么？”。
  • 教程– 通常发布在公司网站或 YouTube 上的视频，演示如何使用产品或执行某些任务。
  • 图表和信息图——产品结构、功能或过程的图形表示。 例如，该图显示了配置 API 时要选择的选项。

如何创建产品文档？

了解目标受众

创建产品文档的第一步是了解该特定文档的目标受众。 回答下列问题：

  • 谁将使用该文档？ – 是初次用户还是更高级的用户？
  • 用户什么时候会访问该文档？ 他们是否正在寻找有关该工具功能的一般或额外信息，或者特定问题的解决方案？
  • 他们将在什么设备上使用它？ 如果是移动设备，视频够清晰吗？
  • 他们的需求和期望是什么？ 用户更喜欢观看动态视频还是图表？

一旦您了解了您的受众及其需求，您就可以开始创建文档。 例如，如果您的目标群体是新手用户，则文档应该可以在每个步骤中访问，并以简单、易于理解的语言编写，并包含详细的说明。

请记住，组织良好的文档不仅可以帮助用户了解产品，还可以节省他们寻找问题答案的时间。 这可以减少客户流失率，即客户停止订阅服务的百分比。

清晰的沟通

创建有效的产品文档不仅涉及选择正确的沟通形式（例如视频、视觉效果、知识库），还涉及清晰简洁的写作和沟通。 产品文档中有效沟通的基本原则如下：

  • 使用简单的语言——避免技术语言和复杂的术语。 例如，您可以说“开始一个项目”，而不是说“启动一个项目”。
  • 具体– 提供示例来帮助用户了解如何使用该产品。 例如，不要说“允许您将团队成员添加到项目中”，而是说“通过单击项目管理页面底部的绿色按钮将团队成员添加到项目中”，并添加带有视觉线索的屏幕截图。
  • 避免被动语态——主动语态更容易理解和阅读。 例如，不要说“经理可以启动该项目”，而是说“经理可以启动该项目”。

还有许多其他原则需要遵循，但最重要的是要记住，有效的产品文档应该是用户可以理解的，并帮助他们有效地使用产品。

在产品文档中使用视觉效果

图像、GIF、短视频、图表和信息图表等视觉效果可以极大地提高对产品文档的理解。 例如，显示“添加团队成员”按钮在页面上的位置的屏幕截图对于初次用户来说可能非常有帮助。 创建文档时，还可以使用清晰的标题和简单的字体来组织文本。

更新和维护产品文档

产品文档不是静态文档。 它必须定期更新以反映产品的变化。 定期更新对于文档实现其目的至关重要。 例如，如果您要向产品管理软件引入新功能，则应更新其产品文档来解决该问题。

发布和分发产品文档

发布和分发产品文档与创建产品文档同样重要。 您需要确保用户可以轻松访问您的文档，无论他们身在何处或使用什么设备。 例如，您可以将产品文档上传到您的网站，或通过电子邮件直接发送给用户。

产品经理的顶级文档管理系统

产品经理可以使用许多工具来帮助他们创建和管理产品文档。 流行的解决方案包括：

  • Google Docs是一项基于云的服务，用于创建和编辑文档。 它是产品经理常用的工具，因为您可以在任何设备上访问它，并且可供多个团队成员使用。
    • product documentation
  • Firmbee是一款全面的项目和团队管理工具，允许用户在世界任何地方实时完成任务。 产品经理可以轻松地组织自己和同事的工作、跟踪进度、控制预算并进行招聘流程。
    • product documentation
  • Notion是一个任务和项目管理应用程序，可用于跟踪任务、笔记和文件。 Notion 是产品经理的一个流行选择，因为它灵活且可以定制。
    • product documentation
  • Zendesk Guide是一种客户服务解决方案，可用于创建和共享知识库文章。 Zendesk Guide 是产品经理的热门选择，因为它允许他们提供支持并帮助客户解决问题。
    • product documentation
概括

创建和管理产品文档是一项经常被低估的任务。 许多数字产品开发人员认为，设计良好的产品是不言自明的。 然而，产品文档不应只是用户指南。

它还应该是一个可以帮助提高客户对产品的认知度并分析他们对新功能的兴趣以及特定文章或解释的浏览量的工具。 此类分析有助于公司更好地管理其产品并改善用户体验。 因此，值得花费时间和精力来创建可以为您和您的用户服务的有效产品文档。

如果您喜欢我们的内容，请在 Facebook、Twitter、LinkedIn、Instagram、YouTube、Pinterest、TikTok 上加入我们的忙碌蜜蜂社区。

A step-by-step guide on how to create and manage product documentation | Product management #31 andy nichols avatar 1background

作者：安迪·尼科尔斯

具有 5 个不同程度和无尽动力储备的问题解决者。 这使他成为完美的企业主和经理。 在寻找员工和合作伙伴时，开放性和对世界的好奇心是他最看重的品质。

查看所有帖子

产品管理：

  1. 产品管理简介
  2. 产品经理的角色是什么？
  3. 为什么产品生命周期管理很重要？
  4. 如何制定高效的产品策略？
  5. OKR 与 SMART 目标。 哪个框架可以带来更好的结果？
  6. 如何定义价值主张？
  7. 识别客户需求和市场细分
  8. 打造制胜的产品概念。 技巧和步骤
  9. 通过有效的产品路线图获得优势
  10. 制作您的数字产品原型
  11. 如何打造 MVP？
  12. MVP vs MMP vs MMF。 产品开发的关键里程碑
  13. 掌握假设检验
  14. 改进产品质量管理的行之有效的方法
  15. 成功产品发布的策略和策略
  16. 通过产品优化提高盈利能力
  17. 衡量产品成功
  18. 如何给产品定价？ 最流行的定价策略
  19. 产品设计的未来。 热门趋势和预测
  20. 何时退役产品？ 影响 EOL 决策的关键因素
  21. 敏捷的产品管理
  22. 产品管理中的 Scrum 和看板。
  23. 什么是精益产品管理？
  24. 待完成的工作。 创造客户真正需要的产品
  25. 什么是增长黑客？
  26. 什么是数据驱动的产品管理？
  27. 产品管理中的 A/B 测试
  28. 有用的产品管理模板。 哪里可以找到他们？
  29. 产品管理中的 Strategyzer 工具
  30. 5 个有用的产品管理工具
  31. 如何创建和管理产品文档？