需求文档常用软件（转向更现代的文档流程以帮助满足用户需求的方法）

本文是对前期完成的有关文档创新一系列文章的补充如 Automation Anywhere 公司的内容结构化实施案例，部分内容来源于 2018年出版的法国研究生课程《Conception de Documentation Multilingue Multimedia》有关论文研究。

今天，数字化和技术创新对技术文档产生了相当大的影响。此外，我们看到技术文档工程师和软件开发人员之间的合作越来越多，这自然会导致代码和文档生产的同步发展。

本文提供的研究基于文献 、关键文章、调查报告、对大中型软件公司的文档和产品经理的采访，以及对各种文档制作过程的分析。结果突出了文档的重要性及其对用户的范围。

为了满足行业的需求，wiki 和 PDF等历史格式正在 转变为基于 Web 和嵌入式的格式，这些格式更易于访问、实现可视化和以用户为中心。此类改变不仅影响输出，还通过合并产品代码和文档影响了文档的生产过程和交付（内容分发）。尽管如此，这种创新成本高昂且受到限制。诸如智能助手和虚拟现实之类的技术开发是否能够很好地满足用户在文档方面的需求吗？

介绍

作为第四次工业革命标志的最新工业实践和日益增长的数字化意味着技术文档的新挑战和范式转变。如果新的生产流程需要混合技术、速度和系统影响，则文档开发必须是动态的和响应式的。在为了响应这一需求，文档工程团队保持警惕，并在每个新产品发布和分发时召集开发团队。将旧格式和结构合并是昂贵且耗时的。投资文档迁移有时意味着放慢新内容的发布或对更多资源的需求。 今天如何管理这些变化？内容同源在此过程中扮演什么角色？

投资文档迁移 意味着放慢新内容的发布或对更多资源的需求。获得满足用户无缝体验的文档需要多种资源、专业和技能。会出现新的角色和新的团队吗？协作是最大化文档效率的关键，因为它促进了流程中的相关变化。今天我们在考虑文档与未来兼容的格式（ VR 、AR、聊天机器人），但如果整个文档消失了怎么办？

方法

我们的研究从文献分析开始。我们发现了涉及 我们假设的关键文章，之后我们将关注范围缩小到可衡量的信息，例如 Data Conversion Laboratory Inc.DCL 发布的调查报告以及我们在采访中获得的对文档流程的解释。为了了解公司和用户在 文档方面的行为变化，我们首先根据我们对文档未来的假设对结果进行分类。我们从 DCL 的2016 年和2018年趋势调查报告以及 TC World 的一篇文章中收集了数据 并且总结 了关于技术产品信息如何影响品牌认知度的调查报告。接下来，我们比较了一下以客户和公司行为为中心的答案。

我们对协作和迁移问题的 研究 基于对 2018年两家不同的软件公司使用的文档流程的分析，一家是大型公司，一家是中型公司( Scality ) 。两家公司最近都部署了创新的文档制作方法， 帮助 我们进行过程 分析。我们请 Scality 文档团队的经理解释公司为什么要做出这样的改变，以及谁参与了这个过程。为了了解文档流程演变的局限性，我们基于2016年技术交流基准调查进行了研究。 我们也 浏览了几篇关于技术演进的文章。

结果与讨论

TC World关于品牌 认知度的技术产品信息总结（来自SDL 的调查）

• 73% B2B 和 B2C 客户说优质 的产品信息使他们更有可能向他人推荐品牌。
• 81% 客户希望以他们的语言提供内容。
• 65% 客户希望内容以多种格式提供。
• 61% 客户希望内容在多个设备上可用。
• 53% 客户在购买产品之前，使用技术产品信息了解有关产品的更多信息。
• 8% 客户在采购决策过程中会考虑一个客户服务部门的价值

94%的客户同意 在单一平台、单一地点或来源中提供所有信息对他们来说很重要 。

2016 年和2018 年发布最多的内容类型

这两年的大部分用户协助都是以出版用户手册的形式（ 80%的受访者），而其他类型的内容（例如，嵌入式UA、视频、培训材料）在2016 年和2018年之间交换了位置。这些格式是仍然在使用最多的八个文档格式中。 在2018年的排名中，我们还可以看到新类型内容的出现。两年来，非静态内容的使用略有增加。

DCL调查结果(2016)

DCL调查结果(2018)

公司出版计划的演变

对于超过一半的受访者来说，推动向新交付机制转变的 主要业务需求与客户需求和期望、发展趋势和生产优化有关。2016年， 88%的受访者发布了PDF，其中超过一半（65%至70%）还计划在未来三年内发布基于 Web 的响应式内容。2018 年的最后一项调查显示，三分之一的受访者希望将几乎100 %的内容导出为PDF 而 其余的计划以基于网络的格式发布。

在这两个时期，制作基于Web 的内容的愿望仍然很强烈，但统计数据显示， 这些目标尚未实现，因为在 2018 年，PDF格式的使用率仍远高于其他格式（与2016年的预期相反）。

DCL调查结果(2018)

DCL调查结果(2016)

DCL 调查 结果(2016)

DCL 调查 结果(2018)

DCL调查结果(2016)

DCL调查结果(2018)

客户的需求

在2016 年的调查中 ，近 60 %的受访者认为客户无法为内容做出贡献。大多数人还表示他们的内容没有满足客户的需求（Q17），事实上DCL的2018 年调查显示，超过40 %的受访者认为他们的客户要求主要是可搜索和个性化的内容和视频。公司强调快速搜索标准，而超过三分之一的客户坚持需要个性化和更具交互性的多媒体内容。

DCL调查结果(2016)

DCL调查结果(2016)

DCL调查结果(2018)

虽然这些调查提供了一些关于公司对文件发布行为的理解的衡量标准，但两个调查期之间的短暂时间间隔并不能提供跟踪长期趋势和意见所需的数据量。

同理心的需要

这里的“同理心”是在用户体验的背景下使用的。收集的结果表明，文档流程的现代化首先有助于满足用户需求。必须有与用户配置文件一样多的可用文档交付物才能遵守用户需求并提高产品效率。 事实上，对文档的需求来自客户和用户。如果出现新的用户习惯，则必须调整技术文档格式。

智能手机或平板电脑的普及、 类似设备的连接性不断提高以及对更快访问信息的需求是这些习惯出现的关键因素。因此，我们发现自己有一个用户样本，其中包括逐渐数字化自己的人和人们谁是数字原住民。因此 ，大多数用户选择在线文档。

要定义文档的类型及其提供方式还需要了解上述用户的兼容性标准。让客户参与用户辅助格式的开发和维护，使公司能够提供高度适应的内容，并评估其 内容的有效性。

针对多用户的公司将从为客户提供服务中获益。正是从这个观察中，我们可以说客户的需求变成了公司的需求。

为公司增值

调查显示，大多数受访者的目标是制作各种数字技术文档。重要的是要考虑到公司也是客户，了解发展趋势和客户习惯。多亏了是 BtoB市场，一些公司也成为了其他公司的技术文档的用户 ，这使他们能够根据技术文档评估创新需求。如果我们进一步了解同理心和客户行为的概念，我们会发现品牌识别和吸引力在变革管理的实施中发挥着重要作用。直到最近，产品文档面向已经购买产品的用户或人员。但今天，目标受众不再只是已经购买产品的用户，而是产品的潜在购买者，试图了解产品的特点和购买前的产品操作 。

这提醒人们获取信息和透明度的重要性，尽管这也是一个问题通过普通观众或有限观众可以查阅的文件证明这个进入视野的产品比竞争对手销售的产品好得多。

因此，公司希望确保与其产品的总体创新战略保持一致，并向前迈出一步或保持与当前的数字化趋势和成本优化保持一致。

两层适配

我们注意到，由于在线产品信息的逐渐普及，使用客户服务的客户数量显着减少（ 2018年为 8 % ）。这对公司来说是有利可图的，因为它可以减轻客户和支持服务的负担，同时还可以改善客户体验。两个都 实体从中受益，但每个实体也必须适应变化，即使习惯和趋势已经确定。事实上，这些变化代表着一场创新竞赛，一个主要适应社会和专业的时期是必要的。每个公司和每个客户的独特性使这 适应时间变量。

此外，另一个发挥作用的因素是产品品种、产品开发周期短、全球市场等增加了技术文档的复杂性。为了解决这种复杂性和那些持续发布，应用了现代内容管理方法（例如，自动重用、转换和 本土化）。

公司为什么要制作PDF？

公司通常从wiki开始构建他们的知识和文档库，这是一种提供简单语法和标记语言的内容交付机制，可通过简单的Web浏览器使用，并且适合贡献。事实上，公司中的每个人都可以做出贡献。 尽管如此 ，随着知识库的增长，使所有内容井井有条变得越来越困难，这随后会使通过搜索引擎找到所需信息变得困难。 正是出于这个原因，许多公司选择制作PDF文档。

PDF文档更易于 构建、维护和个性化， 为那些被wiki淹没的人提供了适当的解决方案。PDF可以从不同的内容生成，例如文本编辑器 文件和结构化语言内容。

PDF解决方案功能强大并提供了许多可能性，但是该格式确实存在一些重大限制。首先，格式与图像斗争。即使在高分辨率设置中，某些图像在生成PDF时也无法正确呈现，这对于屏幕截图或过程中的图片。 PDF 的另一个问题，尤其是软件公司的问题，是命令行的渲染。命令行通常在一行中使用多个空格进行格式化，并且必须遵守 该数字才能使用该命令。PDF 生成认为两个连续的空格是 语法错误并将两个空格“更正 ”为一个，这是一个几乎无法修复的功能，因此导致用户无法复制和粘贴的命令行示例。

用户和开发人员需要改变输出来解决这些问题，两者在文档方面都有不同的技术需求。开发人员和技术作家需要易于构建和维护的 格式，以使所有技术信息都能正确呈现。用户需要一个实用的 和可用的文档。 文档输出和策略的这种变化应该作为一个卖点。

公司内部团队之间的协作是成功更改文档的 关键，尤其是技术服务、团队、工程团队和营销团队。面向客户的技术服务团队帮助识别用户在文档中需要的信息。由于这种合作，当输出从PDF 更改为HTML时所需的内容重组成为可能。、工程团队帮助设置生成和维护HTML所需的环境和工具。

他们经常选择可以简化与技术写作团队协作来 生成文档的工具。营销团队还参与文档，因为同步公司的外观和感觉是成功品牌推广的关键，同时产品管理有助于找到显示新文档输出的正确位置。

从PDF迁移到HTML的 Scality 公司的过程

在我们观察到的第一 家公司，第一步是确定HTML文档的显示位置。产品经理和营销团队做出了决定，选择将文档集成到UI （用户界面）中，在其中管理和监控产品。

安装产品后，合作伙伴和客户只能通过凭据访问UI ，因此无需安装文档-还需要一个新的文档门户 来托管所有内容。开发团队致力于在UI和门户中为将托管生成的HTML的文档创建一个新空间。 设置HTML后，技术编写人员与技术服务部门合作，调整内容以满足用户 需求。

从门户帮助到嵌入式帮助

嵌入式帮助是大型软件公司的首要任务。目标是尽可能地概括用户帮助面板，以便我们在下一个版本中进行品牌覆盖。当我们 在 软件行业工作时 ，我们参与了在逐步披露信息的策略 中 创建嵌入式帮助。例子，在分析的第二家公司 中，嵌入式帮助由工具提示或用户帮助面板组成，可通过按F1键获得。UA面板显示在通过悬停在命令或对话框上可访问的工具提示之后。工具提示的目的是简要描述命令。 用户帮助面板使编写者能够在 软件本身中重用任务主题和功能过程。但是，软件行业的主要参与者如何改变用户帮助中的工具和格式？从在线门户迁移到嵌入式帮助是单一来源和结构化语言大放异彩的地方。例如，条件文本的使用使得即使在文本已经写完之后也能想到“重用” 。

出于统一目的，对现有 Webhelp和 Tooltips进行了分析，以了解UA面板的需求和重用现有内容的机会。我们在 DITA体系结构中工作，以极简格式提供适用的概念和任务，浓缩到足以出现在用户帮助中。分析可能会导致文档更改以及使用不同条件文本重复文档部分以适应每个指南的多个指南格式。单一来源的目的是从一个来源发布到多个输出（多种格式，多种受众）。条件文本是一种工具，使作者能够为同一文档中的每个输出自定义文本内容。但是，根据我们的经验，我们观察到条件文本 习惯于与相同的受众分享相同的信息，同时遵守公司的风格指南。

每个部分小节都必须更新，因此我们可以说最终这会 为文档工程师带来更多的工作。 不过， 我们也可以考虑，这将使我们能够在同一个文件中管理多种格式。

重用的粒度可以尽可能粗，也可以尽可能细。 即使我们从不使用软件本身的章节，它也包含指向在线门户所述部分的链接。大多数重用的元素是命令的步骤和简短描述，它们使编写者能够描述命令以及如何使用它，从而可以将其转化为目标以及如何完成它。

我们首先分析了操作和上下文栏及其工具提示，以评估命令的准确性，以及在即将发布的产品版本中迁移到Panel帮助的相关性。该分析是在开发人员和文档的技术作者所有者之间合作进行的。我们需要熟悉文档和产品，才能在界面中选择用户所需的信息。 迁移是一个重要的审查机会 并更新现有文档，以 符合新标准和样式指南。因此，由于选择信息的风险， 很难将 这项任务交给劳动力的新成员。 然而，这也可以被视为一个机会，例如通过雇用某人 专门 针对 工作移民的目的引入了 新鲜的眼光。

为什么公司要生产嵌入式帮助？

尽管受到大小的合理限制，嵌入式帮助提供了极大的文档创新能力。例如，可以集成活动图形元素来展示特征行为（例如，视频、动画gif ）。此类内容对于向尽可能广泛的受众描述命令至关重要，在_ 事实上 ，因为它不需要翻译，用户可以理解更多。

此外，积极的视觉效果更能吸引注意力，并且比文字更不可能混淆信息。云或现场的多个输出中以用户为中心的文档意味着要考虑每个内容输出的内容可用性。新的图形格式涉及服务器上的更多数据和网络活动。用户协助还采用知识库和公司拥有的博客的形式。联机帮助中的链接确保了对这些工具的可访问性，但作为嵌入式帮助，它们需要越来越多的 用户空间。这些格式是否仍然适用？ PDF、知识库、博客……迁移也是导致某些文档格式消失的原因。

当然，参与该过程的每个团队的工作量 都会增加，因为每个人都需要继续处理他们的项目，同时每周还要分配一些时间来启动变革。

面临风险的公司和团队资源

用户协助方面的创新需要多个决策者的协作，因为它代表了额外的成本和工作量的增加。对于技术作家来说，实施新方法意味着学习新的软件创作工具、新规范（例如DITA ）和新 技能。文档作家们需要训练发展不同的技能，取决于他们是为嵌入式 帮助、视频还是聊天机器人写作。培训行业报告指出，2014年美国大公司平均为员工培训分配了1740万美元的预算。此外，培训 和实施增加了_团队，除非雇用更多的文档工程师，否则这可能会导致生产力下降。即使创新是一种成本并且文档被认为是一种成本，我们仍然需要在用户协助方面进行创新，以保持该领域的相关角色。

如今，在大公司中，创新由高层管理人员决定，由工具团队或软件发布团队实施，并由开发人员、编写人员和测试工程师处理。

合并技能

我们看到了一种合并策略，包括交付代码和文档，同时遵循敏捷项目模式。_ 一个问题是，规范有时会被可识别为概念证明的内容所取代，尽管作者更频繁地提供文档样本_ 以后必须对文档进行大量审查。就嵌入式帮助 而言 ，渐进式披露的实现意味着 代码基础架构的更改以及开发人员和编写者之间的协作。编写者和决策主管需要制定代码中所需内容的规范，以便编写者能够 在 界面中使用结构化创作。编写者在编写代码增强规范时，会增加与开发人员协作的需求，并了解在您的职业中可以被视为无缝的内容如何在其他协作者看来不清楚。

敏捷方法

协作是敏捷方法的一项主要原则，它也有助于让团队意识到他们的责任。

公司中的敏捷方法表现为如何组织工作流以促进协作、易于维护和提高生产力。软件公司敏捷方法的一个很好的例子是处理代码和文档的方式。

使用版本控制系统时，将 文档存储库与 产品的代码存储库一起保存有助于改进产品的周期。首先，代码和文档是同时开发的，这意味着团队紧密合作并遵守相同的截止日期，从而确保一致性和公司内部 的严谨。

此外，文档包含在产品的生命周期中，以相同的方式进行维护、版本控制和审查。

最后，文档审查过程与产品的代码测试同时进行，这导致代码和文档同时发布。 _

用户协助的未来会怎样？

2016年技术交流基准调查显示，阻碍技术写作团队确保内容一致性的两大障碍是

缺乏统一的内容策略（42%）和为工作设计的软件工具（ 41 %）。缺乏合作也受到指责（38 %）。该调查还提出了意识问题，23%的受访者表示技术传播内容开发的进步是其他人看不到的 在整个 企业。文档过程正在发生变化和发展，以产生对用户更清晰的用户帮助，从而使文档更易于理解，同时也节省了时间。随着技术的进步，公司必须使他们的用户帮助保持最新并与 他们的 产品。然而， 对于增强现实、虚拟现实甚至人工智能来说，用户协助会是什么样子？我们如何在增强现实中引入清晰有效的文档？在虚拟现实中？此外，这种不断演变的限制是什么？

嵌入式帮助并不是什么新鲜事

1997年， Microsoft 在其Word软件中引入了一种嵌入式帮助功能，称为Clippy（又名Clippit）Office助手。Clippy不时提供提示，并且始终在场，以防用户需要帮助。_ _ _ 该功能彻底失败，微软终于下架了 它在2007 年从其软件中删除， 在Windows XP中默认禁用它之后。在1990年代，人工智能系统还没有今天那么先进。我们现在知道Clippy的主要问题是它的无所不在。一开始被视为“有趣”，Clippy很快变得烦人 因为它不断尝试帮助用户执行 简单的任务。Clippy甚至被指责近十年来让人们远离虚拟助手。

智能系统概念在2011 年随着Apple的Siri重新出现，用户可以通过它发送文本、电子邮件、预约和搜索 网络，只需与 他们的手机通话。

聊天机器人

企业正在从不太直观的用户界面( UI )转向更身临其境的信息访问方式。_ 考虑到消息传递应用程序的增长趋势，许多公司现在在其网站中使用聊天机器人。与更传统的用户帮助不同，使用聊天机器人的用户 可以 要求精确的 信息，明确地定位它，从而避免阅读冗长而完整的文档，在其中定位用户需要的特定信息可能会很棘手。

聊天机器人可以仅具有对话式UI ，也可以使用人工智能。设计一个只有对话式UI的聊天机器人，有必要预测用户可能使用的所有可能的语音，因此聊天机器人可以识别它被询问的内容，从而被 有用。 例如， 像“yes”这样的简单词 将要求聊天机器人能够识别“yes”、“ yup ”、“yeah”、“yep ”等。如果聊天机器人是文档门户，其目的是帮助用户找到最适合他们案例的信息，那么聊天机器人可以使用预定义的答案 进行配置。

增强现实和虚拟现实

增强现实 (AR)和虚拟现实(VR )的日益普及已经让位于另一种学习方式。基于计算机的培训和基于网络的培训，例如电子学习模块，已经找到了自己的位置。不过，多亏了AR和VR ，我们现在谈论虚拟 训练。 可以通过 增强现实提供有关一个人所处环境的信息。

戴上眼镜，用户可以看到周围的环境，并显示信息，从而暗示用户的训练对象就在他们面前。 除非 ，例如，如果技术人员想要事先培训或练习并且没有机器。虚拟现实可以提供上下文。因此，将增强现实与虚拟现实相结合会导致沉浸式培训：增强现实为上下文提供信息，虚拟现实为信息提供上下文，使用户辅助更加精确和实用。

为了让聊天机器人、增强现实和虚拟现实更高效，人工智能是必不可少的，因为它可以了解用户的需求并提供相应的信息。如果没有人工智能，聊天机器人可以很快达到极限。您需要预测用户的问题和需要，以及可能的答案。 AI 的主要问题是它需要时间变得更聪明，并且只有人们继续使用它才能改进，但是如果用户发现系统有缺陷，他们就不会使用它，从而使AI 系统无法改进。

结论

我们今天可以确认的是，人们越来越数字化，并且期望文档与连接对象一样强大，可以帮助他们并成为他们日常生活的一部分。没有什么比拥有多合一界面更接近的了，但真正的成本是多少？

与正在转型以适应公司需求的开发团队不同，对客户支持的需求越来越少。公司内部正在涌现短期合作团队，这些临时技能的融合改变了包括文档专家在内的劳动力。

辅助技术，例如Apple 的Siri、Amazon 的 Alexa 或Google Now已经很成熟，并且随着时间的推移已经有了很大的改进。数字化转型领导者还打算将用户置于虚拟现实和增强现实等沉浸式环境中。我们可以期望用户帮助会跟随这个趋势吗？未来用户指南是一个声音 ，告诉您该做什么以及您可以与之互动？ 仍有很多进展要做，财务问题对制造商和消费者都至关重要。

一方面，企业不得不投入大量资源来制作和传播专用于文档人工智能 AI 技术 ，而另一方面，并非所有客户都有购买此类产品的手段。使 AI 与可搜索、可重复使用和相关的文档兼容仍然过于复杂，并且该技术提供的信息目前仍然不完整。 正是由于这个原因，技术文档的创新不如技术创新快。知道所有这些自动化数据处理都来自算法、语义复合体、 由专业人员实施的规则，我们可以说这更多是人的问题而不是技术问题 。

参考书目

Oevermann, Jan. “技术文档4.0”。TCWORLD，2018 年3月，来自http://www.tcworld.info/e-magazine/technical-communication/article/technical-documentation-40/

技术信息传播的创新机会

技术信息传播的创新机会系列-HTML5

启用人工智能 OpenAI 中英文结构化写作创新

技术传播创新-直接在搜索页中呈现完成任务的步骤无需打开目标页

也许是时候重新考虑文档了

,