推出新产品时的一个最佳做法是进行产品发布准备工作。特别是，我们要重点编写新产品文档，以支持产品发布。否则，潜在用户在购买新解决方案后，将无法获得相关信息作为参考。
作为更广泛营销战略的一部分，产品经理和产品团队成员应继续阅读，了解下次发布产品时应遵循的 15 项最佳实践。最后，您将了解如何将这些重要文件做到最好！
我应该注意哪些类型的产品文档？
在深入了解最佳实践清单之前，让我们先澄清一下产品文档有哪些类型，以及每种类型的预期目标：
- 产品需求文档** - 产品需求文档或 PRD 是一种内部产品文档，用于帮助企业满足发布标准。它解释了最终产品应为用户实现的目标，但没有具体定义如何实现或在哪里实现。然后，开发团队和测试团队使用 PRD 使产品符合业务需求，为发布做好准备。PRD 在软件产品中很常见，但也可用于遵守任何产品路线图。
用户指南和自助服务 - 产品团队需要创建用户指南，这是成功发布产品的软前提。顾名思义，这是帮助最终用户在使用新产品时最大限度地提高工作效率的文档。在这里，所有面向用户的主要功能都应得到充分解释，以便客户获得最大价值。更好的办法是，在自助式外部知识库中共享这些指南，以便客户可以自助使用！
设置、安装和配置指南 - 如果产品需要设置、安装和配置，这是您需要创建的另一种技术产品文档资产。其目的是从用户的角度以及开发人员的角度（如果适用）清楚地说明这些过程。如果是软件文档，则可能跨越多个设备和多个操作系统；这一点需要注意。
- 营销资产** - 你可能不认为这是产品文档，但它确实是！营销资产的风格和格式会在客户开始使用产品之前影响他们对产品的看法。给客户留下好印象至关重要。如何描述产品的新功能？面向哪些受众？它将如何改善人们的工作或个人生活？你和整个公司是否希望客户这样想？
发布新产品时文档的 15 个最佳实践
产品文档入门之后，接下来是最佳实践列表：
1：开个头！
刚刚开始编写产品文档？好极了！现在，不要犹豫，开始行动吧。很多人都想把产品文档做得完美无缺；而在追求完美的过程中，他们会被任务所累。先把服务的基本概念写在纸上，然后集中精力整理，给客户留下深刻印象。发布说明可以很好地定义基本概念，然后您就可以在此文档的基础上进行扩展。
2：保持简单，愚蠢...
简称 KISS，这是 60 年代在美国海军中流传的一条真正的设计原则（双关语）。这一原则同样适用于产品文档。问问你自己"如何以所有人群都能理解的方式传达必要的信息？
要将这一原则应用到您的产品愿景中，我们推荐使用 Flesch-Kincaid 可读性测试。像 Grammarly 这样的内容分级工具通常使用这一系统。在分析书面内容时，它能为您提供相当于美国高中成绩的分数。以 8 年级或 13 至 14 岁的入学年龄为目标，最大限度地提高内容的可读性--等等，我们本可以说......你的文章有多容易理解。
3：了解目标受众
那么，你已经开始了，并且保持了简单。例如，软件公司的目标受众与汽车制造商的目标受众截然不同。
让我们想象一下，一家教育软件公司专注于提供简单的工具，帮助青少年学生循序渐进地学习概念。您脑海中的第一个想法可能是："那么，目标受众就是儿童，对吗？不一定...目标受众是幼儿园或高中软件包的主要决策者，如信息技术部门和负责采购的内部利益相关者。次要受众是青少年学生，他们可能会看到教育软件的使用情况，并倡导在学校使用。
4：关注价值，而不是故事
虽然人人都喜欢好故事，但客户更想知道你的产品能带来什么价值。它能简化任务或工作流程吗？你的产品是否可以离线使用，而竞争对手只能在线使用？与其他竞争产品相比，你的产品是否能更快地完成任务？
这些例子构成了特定产品的独特卖点（USP）。关注并突出 USP 将吸引潜在客户，帮助他们了解你有哪些别人没有的东西，从而扩大市场份额。您可以通过对行业内的竞争对手进行竞争分析来确定 USP。
5：利用格式对信息进行分类
文档不应是一大块文本。这对于终端用户来说，很难进行扫描和浏览。相反，应使用标题和其他格式选项来分割文本。
H1 标题是人们点击页面时首先看到的内容。H2 和 H3 则是页面主题的副标题。您可以使用项目符号或编号列表将内容分组，方便阅读，甚至还可以使用 Rich Snippets 来提高搜索引擎优化和 SERPS 的可见度。如果您具备 Markdown 知识，Docsie 等在线 Markdown 编辑器可提供大量格式选项，让您的产品文档与众不同！
6：将文档保存在一个中心位置
最糟糕的事情莫过于发布技术文档后，才发现长期监控和管理文档是多么复杂。如果文档需要更新怎么办？原始文档在哪里？我们如何发布新版本的页面？如何将这些内容翻译成其他语言？
关于这个最佳实践，我们不得不提到 Docsie！在线知识库软件可以将文档存储在一个集中的云位置。在这里，员工和承包商可以对内容进行协作，加快完成工作，为发布做好准备。Docsie 可在您需要更新知识时提供版本控制管理，并为全球内容本地化提供语言管理。如果您想实现全球内容创建自动化，我们还有一个灵巧的人工智能语言翻译机器人，可在后台为您准确翻译！
7：一图胜千言
虽然写一篇冗长的说明如何做这件事是可行的，但这并不是教授最终用户的有效方法。取而代之的是，用图片甚至动态图片向他们展示！
尝试为每个产品文档制作配套的视频教程。这样，喜欢阅读的人可以浏览文字，而视觉学习者则可以选择视频。同样，GIF 和图片也能帮助用户了解你所指的内容，尤其是在软件用户界面（UI）中。适应各种学习方式将帮助你帮助更多的用户，这意味着你的产品有更大的潜力。
8：学习 vs 目标 vs 理解 vs 信息
文档的意图是什么？对于在线产品文档而言，用户意图至关重要，它可以帮助您将内容与用户旅程的各个部分相匹配。
学习 - 如果一个人以前从未见过某种东西，学习内容可以帮助他们了解基本原理。
-
目标** - 这类内容应帮助用户实现目标，例如 "如何从 Docsie 导出 PDF 文件"。最后，用户将实现目标：导出 PDF。
-
理解** - 也称为研究，适用于对某一主题已经有所了解，但希望更深入理解的客户。
信息 - 客户有一个问题，希望得到具体的答案。这可能很简单，比如某个特定地点的实时天气，或者关于 "如何建造树屋 "的视频。
9：使其可搜索
在公开文档之前，用户能否在文本中搜索关键字？
如果不能，我们建议寻找一个支持搜索的文档平台。无法快速查找信息是阻碍用户使用文档的首要因素。如果用户找不到信息，就会产生挫败感，增加客户支持团队的工作量，并带来负面的整体客户体验（CX）。哦，如果你想知道的话，Docsie 确实支持全局搜索！
10：准备收集可操作的反馈意见
文档撰写人员会意识到，内容的初始版本必然会发生变化。在公众看到文档之前，撰稿人只能互相交换意见和反馈。
我们认为，一旦文档发布，收集反馈意见是必不可少的。这样，您的撰稿人就可以通过倾听真实客户和最终用户的意见，将任何与内容相关的消极因素转化为积极因素。无需到其他地方寻找，您可以利用 Docsie 中的反馈收集功能！
11：提及主题时链接至页面
这一最佳实践与搜索引擎优化和网页导航结构有关。
当你提到一个关键词时，你会链接到它吗？当你提到其他主题时，用户可能还不了解当前页面上下文中的其他主题。您应该链接到任何有文档的提及主题，因为这可以让读者在了解主要主题的同时快速参考次主题。
12：清晰而不是模糊
编写产品文档时，清晰胜过含糊。你可以使用通俗易懂的英语来避免歧义，这基本上意味着除非绝对必要，否则要避免使用行话和技术性语言。如果你确实使用了专业术语，一定要紧接着为非专业读者写一个简化的定义。
"如果您在理解本文档中的信息时遇到问题，请向我们的客户支持代表询问有关如何克服理解困难的更多细节"。
"如果显示的内容难以理解，您可以向客户支持人员寻求帮助。
您更喜欢哪一种？
13：创建模板，让文档更快捷
随着新产品的推出，加快文档创建过程是当务之急。您可以使用模板来做到这一点。
模板为页面定义了可重复使用的结构，帮助撰稿人更快、更一致地创建内容。您还可以为不同的内容风格创建多个模板。Docsie 提供一系列预建模板供您使用，同时还支持自定义模板。
14：为撰稿人建立语气和风格指南
你的撰稿人有多大自由度？
对撰稿人进行约束非常重要，因为这可能导致产品文档的最终草案不一致。您可以通过语音语调（ToV）指南和内容写作风格指南来做到这一点。
- 语气** - 不是你说了什么......而是你说的方式。你希望撰稿人正式得体，还是更加随意？允许幽默，还是主题更严肃？您的内容是更具对话性和激情，还是只需要冷冰冰的事实？
风格指南--这份文件可以解释公司的使命宣言，以及撰稿人在撰写和排版网页时如何遵循既定风格。这里可能包括目标用户角色、元描述等搜索引擎优化原则，以及引用或参考文献要求（芝加哥、美联社风格等）。
15：使用强大的知识库平台发布文档
如果您的书面内容是燃料，那么您使用什么载体来将信息传递出去呢？
一个功能强大的知识库平台对于发布高质量的产品文档至关重要。如果文档不可用，或者页面加载缓慢，那么创建这些文档所花费的所有努力都将付诸东流。
您需要有能力导入现有文档、与内部团队合作编写内容、创建和编辑新文档、嵌入丰富的动态内容并发布到知识网站。版本控制对于长期文档更新以及全球内容本地化的语言管理和自动翻译也至关重要。
你猜对了！Docsie 提供所有这些功能。体验一下这些功能，试试我们的永久免费计划！