这个假动作告诉我，我需要通过客户的棱镜来看待我们的产品。然后，传说中的电灯开关就 "打开 "了。如果我提供的产品能解决客户的痛点，然后用专业的产品文档来支持它，我们就会有一个赢家。
而我也发现创建专业的、美观的、易读的产品文档并不是一件容易的事。但如果做得正确，产品文档可以使快乐的客户欣喜若狂，最终增加收入。
创建专业产品文档的最佳做法是什么？
这些最佳实践创造了美观、信息丰富和易于使用的产品文档。遵循这些准则将帮助你提供产品文档，使一个好客户变成一个伟大的客户。而优秀的客户最终会帮助公司增加收入，产品文档是客户体验的一个重要组成部分。
1.理解你的目标受众，给他们想要的东西
必须知道你的受众的期望是什么。例如，产品文档是为管理员还是终端用户准备的？你的目标受众的范围可能需要为管理员写技术性的东西，或者为终端用户写明确定义的条款和说明。
创建专业产品文档的最佳实践是了解管理员或最终用户层面的客户期望。收集识别受众信息的一些方法是：
- 问卷和调查
*感知的受众反馈
-
公司集思广益
-
流行的客户意见的反馈
-
客户圆桌讨论
2.创建一个文件计划作为最佳实践
编写文档计划可以帮助设想项目实施过程中的任何潜在瓶颈。创建产品文档可能具有挑战性，最佳做法是创建一个文档计划，以帮助预见文档过程中可能出现的问题。
创建一个文档计划的好处有以下几点：
可操作的项目-审核任何现有的文件，以挽救可重复使用的新产品文件计划的适用信息。
遵守模板和风格指南-如果产品文档是为新产品准备的，确保它保持在行业的声音和风格之内，或者如果文档与现有产品有关，保持现有的风格指南和模板，以**确保品牌的连续性。
文档流程工具化 - 文档工具化可以定义和简化产品文档流程，同时确保团队工作的连续性和对文档开发流程的更好理解。
3.简化产品文档是一种最佳做法
2016年进行了一项研究，以确定有多少用户阅读产品文档。结果令人大开眼界，因为他们发现只有25%的用户不阅读产品文档。调查发现终端用户不阅读产品文档的部分原因是：
用户没有耐心 - 随着通过网络获得即时信息的出现，用户通常在发现问题的答案时变得没有耐心。由于特定产品需要大量的信息，阅读在线或离线的产品文档会很费劲。
跳跃综合症 - 用户经常跳过必要的产品文档，直接阅读如何使用产品的基本知识。用户通过与产品的互动来学习和理解产品的工作原理，而不是阅读详细的说明。说明书必须尽可能的清晰和翔实。
令人困惑的布局和结构 - 手册往往是以难以理解和遵循的格式编写的。许多用户发现产品文档令人困惑，或者与他们的问题无关，变得沮丧，对阅读手册感到灰心丧气。通常情况下，公司没有进行详细的受众研究，没有正确理解用户的需求，而变得混乱不堪，无法完成阅读。
4.包括屏幕截图和图形信息
把产品文档看作是一个讲述产品故事的路线图。引导客户沿着一条容易被屏幕截图或其他图形[dentified]的路径前进(https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250)，以及每个不同的图形如何与其他图形互动。清楚地解释用户在看什么，或者当一个功能被激活时，它对产品有什么反应，以及接下来会有什么期待。确保每个图形都是有目的的，并且产品的工作流程是相互配合的。
5.使用交叉链接以更精确地理解主题。
我发现交叉链接在阅读产品文档时是非常有价值的。了解一个特征或功能过程的作用，对交叉链接到相关的主题有极大的帮助。此外，通过交叉链接相关的数据点，关于系统如何互动和工作流程的整体情况变得更加明显。
6.记住产品文档的KISS原则。
在创建文档时，记得使用[KISS（Keep It Simple, Stupid）原则]（https://www.wrike.com/blog/understanding-kiss-principles-project-management/#What-does-KISS-stand-for）。然而，彻底记录过程是很重要的，但不要达到文档过剩的地步。此外，文档使用者可能正在寻找特定项目的某些信息，所以坚持KISS原则可以更容易地浏览和理解文档。
例如，简单的记号就足以解释一个功能，也许还有一个参考（交叉链接）到主要的主题。保持事实的简洁，不要过分强调，这样用户可以很容易地搜索与他们的需求相关的信息。他们可能没有兴趣阅读产品的每个方面。
7.适应不同的学习风格
每个人都有一个不同的学习风格。有些人喜欢深入的描述，而其他人可能喜欢图形和视觉表现。然而，有些用户通过亲身参与而不是集中阅读来学习。
在创建有效的、内容丰富的产品文档时，要确保包含所有的学习风格。例如，插入屏幕截图、图表、结构化文本或视频链接等图形，有助于确保所有的学习方式都能理解产品文档。
8.个人化和结构化的入职培训内容
根据受众的角色对产品[文档]进行个性化处理(https://www.deanhouston.com/news/knowing-audience-document-right-document/)。在入职内容中，根据目标受众的角色创建不同版本的文档。例如，管理员的问题可能与高级用户对文档的问题不相关。
文档可以通过创建稍有不同的文档版本，更多的针对目标受众的角色，引入一层个性化的内容。根据听众的角色来修改入职培训的内容，使文档具有个性化的元素。
9.为特定的听众明确定义术语
根据目标受众，解释整个文档中使用的每个术语的含义是一个好的做法。如果受众是内部的，你可以使用更复杂的术语，并做一些澄清。然而，当外部用户访问文档时，没有办法知道用户的专业知识。
明确定义独特或复杂的术语，可以为所有内部利益相关者和外部用户建立更好、更有效的沟通。
10.提供一个收集用户反馈的方法
文件反馈提供了关于文件有效性的有力信息。提供一个链接或一个带有 "喜欢/不喜欢 "的简单按钮，以收集关于文档质量的宝贵信息。通过收集用户反馈，可以完善和改进文档。
11 避免使用扁平结构的文档
在创建产品文档时，确保文档不是写成 "扁平结构"。阅读一个充满平面文字的文档是很费力的，而且也会变得很乏味。此外，如果信息与所讨论的主题相关，读者可以快速消费，那么读者对文档的兴趣就会提高。
通过突出选定的信息或整合视频、图片、链接和其他方法来打破连续的、平面的文字，以提供更好的用户体验。此外，通过以 "一口大小 "的块状方式提供文件内容，读者会有更愉快的体验，并不太愿意阅读该文件。
12.创建对搜索引擎友好的文档
一个在线产品文档的最佳做法是确保它的写作风格是文档SEO友好。确保文档的编写是为了最大限度地提高整个互联网对你的文档的搜索结果。客户可能需要搜索他们的文档，当他们没有托管网站的明确链接时，通过输入搜索词，在SEO友好的情况下，回复会更快、更简洁。
13.保持产品文档的最新性
保持产品文档维护是至关重要的，主要是如果在网上访问。通常，产品的要求会发生变化，在线文档必须反映任何新的变化或更新。因此，用户文档需要是最新的，并为任何最近的更新而刷新，并确保客户被通知并了解产品文档的变化。
14.理解用户可能不会阅读产品文档
一项 2014年的研究发现，用户并没有完全阅读所有的产品文档。不阅读文档的主要原因是：
-
产品文档过于复杂
-
文档没有直接解决他们的问题
-
用户由于没有阅读文档而没有使用产品的许多功能
-
与其阅读文档，许多用户更喜欢 "动手 "学习。
15.同时管理动态和静态内容
产品文档随着更新、新功能、更正的内容、更新的维护警报和其他项目而不断发展。这种更新被认为是一个活生生的文件，根据产品的要求不断地发展。
静态内容为用户提供了在整个产品生命周期内不会改变的数据。静态内容的想法是给用户参考，特别是新用户，在产品的生命周期中保持静态的信息。静态内容对于丰富的文档是至关重要的，但通常在动态文档中处于次要地位。
当内容[被划分为动态或静态]时，维护文档集更容易。（https://brainly.com/question/24688083）。当文档被归类为动态或静态时，产品生命周期的文档可以更容易实施和验证。对于新功能的更新（静态）或详细的产品更新（动态），文档中可能会有小的变化。
16.产品文档可用性的最佳实践
尽管用户不一定会读很多产品文档，但当他们需要的时候，他们会立即想要它。传统的文档交付方式是有一本印刷的手册，与产品一起旅行。然而，在今天的数字、网络世界中，文档通常是通过网络传递的。
无论产品文档是如何交付的，都必须有随时可用的访问点。因此，今天提供文档的主要方法是：
离线文档 - 许多产品都有印刷的手册或 "快速入门 "的捷径表。这些文件通常是 "一次性的"，不容易分发。然而，许多手册可以选择以封装的PDF格式提供，促进便携性或选择按需打印出来。
在线文档-每次你在谷歌上搜索问题的答案时，你可能都会抓取一些在线文档的片段。网络的出现已经取代了终端用户的打印手册或产品文档材料。在线文档的一些好处是：
1.远程工作--大流行病告诉我们一件事，在家里工作可以像在办公室一样富有成效，特别是当我们的问题有了在线文档的解答。
2.协作--有了一个随时可以访问的在线文档门户，团队成员可以即时分享信息，形成团队合作，这在办公室里往往是不可能的。
3.移动友好 - 移动设备如iPad和智能手机的出现已经慢慢取代了PC的日常互动。你可以用智能手机轻松访问在线文档，任何令人头疼的产品问题都可以随时研究，甚至在你最喜欢的咖啡馆吃午饭时也可以。