本文节选美国高通公司高级文档工程师 Geetha Haridas 2023 年的博客。

用户文档在帮助用户了解如何使用软件产品方面发挥着至关重要的作用。尽管“没有人阅读文档”的信念仍然存在，但 Schriver（1997）的研究表明，无论年龄或性别如何，用户都会阅读文档来理解和使用产品和技术。然而，只有满足用户的要求，文档才能成功（Schriver 1997）。对质量文档的需求催生了诸如信息设计之类的概念，这些概念涉及为用户创建可用的信息。然而，信息设计是一个广阔的领域，有多种定义方式。信息设计有时涉及增强文档的外观和可读性（Burnett 2001）。在其他一些情况下，信息设计是文档工程师为创建可用文档而进行的解决问题的活动（Carliner 2001）。关于信息设计的多种且相互矛盾的观点常常使得该概念难以在实际环境中应用。

三阶段过程：

1. 设计

2. 发展

3. 交货

什么是信息设计？它如何为文档增加价值？本文探讨了理解信息设计的挑战，并提供了软件产品文档背景下信息设计的定义。此外，本文描述了应用信息设计来创建满足用户特定要求的产品文档的三阶段过程。

定义信息设计

在定义信息设计时，理论家通常强调文档的视觉和交流方面。

Burnett (2001) 认为“信息设计是一个关注组织和呈现信息以影响读者理解的方式的领域”(Burnett 2001, p.247)。该定义强调了文本、空间和图形元素在设计打印文档或网页时的使用

Sless（1994）指出，信息设计应该应用于帮助读者实现特定目标，并认为“信息设计是管理人与信息之间的关系，以便人们可以访问和使用信息”。

因此，信息设计可以在不同的背景下以不同的方式定义和实践。要了解如何将信息设计应用于软件产品文档，必须了解用户如何使用产品文档。

软件产品的用户需要功能或操作方法信息来执行与安装、管理、使用产品或对产品进行故障排除相关的任务。不准确的信息，无论多么易于阅读，或者视觉上多么优雅，都无法满足这些用户的要求。因此，文档工程师必须设计产品文档以实现实际目的，以便用户能够有效地定位和使用信息（Schriver 1997）。在这种情况下，信息设计是一种帮助用户实现特定目标的解决问题的活动。即便如此，视觉效果的呈现和使用也是此活动的一部分，因为它们使信息更加全面和可读。

在定义信息设计的目标时，Carliner (2001) 规定了一种基于模型的方法，该方法在三个层面上解决信息设计问题：

身体素质，寻找信息的能力。认知（智力），理解信息的能力。情感（情感），对信息呈现感到舒适的能力。

该模型或框架指定文档应达到的信息设计级别。该模型还与 Redish (2000) 提供的以下定义相关，该定义采用实用方法并将这些信息设计级别转化为特定的用户需求：

“信息设计是我们开发适合用户的文档（或通信）的工作。为用户工作意味着必须或想要使用该信息的人可以：

找到他们需要的东西。了解他们发现了什么。适当地使用他们理解的内容。”这个定义表明“大多数功能性信息的用户正在使用这些信息来实现个人目标——回答任务或完成任务”（Redish 2000）。它侧重于帮助用户查找、理解和使用信息来实现他们的目标，这是产品文档应该实现的主要目标。

基于此定义，产品文档上下文中的信息设计可以定义为设计、开发并向用户提供可用信息的过程，以便他们可以使用这些信息有效地执行任务。

设计和交付阶段的重点是帮助用户“找到他们需要的东西”。这些阶段包括了解用户需求、构建和交付信息，以便用户可以找到所需的信息。

开发阶段旨在帮助用户“查找、理解和使用信息”。此阶段涉及创建帮助用户执行任务的信息。可用信息是指为满足用户的知识水平而量身定制的准确信息的正确水平，既不多也不少。

信息设计是贯穿文档生命周期各个阶段的过程

信息设计作为一个过程

关于信息设计的一个常见误解是，它可以作为一组活动在已完成的文档上执行，以使其更可用（Schriver 1997）。相比之下，信息设计是一个贯穿文档生命周期各个阶段的过程。Carliner (2001)、Sless (1994) 和 Redish (2000) 使用流程模型来演示如何在文档生命周期内实践信息设计。

设计、开发和交付是构建文档生命周期的三个关键阶段，尽管可以添加中间阶段。例如，起草、测试和编写内容是开发过程的一部分。为了设计满足用户需求的文档，文档工程师必须将信息设计作为此生命周期内的一个过程来进行，并实现特定的目标。

第一阶段：设计在设计阶段，信息设计涉及定义文档的目的以及如何实现该目的。

Schriver (1997) 指出，信息设计涉及识别文档可能有益的情况，并发现如何利用它们来实现特定目标。因此，为了定义文档的目的，文档工程师必须了解用户需求和产品功能。

确定用户需求涉及：

了解设置和使用产品所涉及的用户角色。确定每种类型的用户可能执行的任务。了解执行每项任务所需的知识水平。通过让用户参与这个过程，文档工程师可以创建适合用户需求的信息（Schriver 1997）。

了解产品会涉及：

了解产品的用途。识别产品中的工作流程。通过了解工作流程并将其与用户需求进行映射，文档工程师可以确定他们必须记录的任务以及他们必须创建以支持产品的指南类型。

此阶段的目标是创建大纲或结构来定义必须如何编写文档。Carliner (2001) 将“创建大纲”列为文档流程中的一个单独步骤，将其描述为确定如何编写指南的蓝图。Burnett (2001) 将大纲描述为一种工具，可以突出信息流中的差距、不一致和缺陷，并指出文档工程师可以通过创建大纲来安排和检查他们的想法。

设计阶段制定的大纲主要决定了用户能否“找到他们需要的东西”。

第二阶段：开发在开发阶段，信息设计涉及创建高质量的内容。文档工程师必须确保他们编写的内容符合用户的经验水平（Hargis 等人，2004 年）。文档工程师必须在提供过多和过少信息之间找到平衡。创建高质量文档还涉及增加信息的价值和消除信息的冗余。

为文档增加价值涉及提供有关特定任务的相关上下文，而不质疑用户的智力。它涉及通过以下方式确保信息的清晰度和完整性：

使用基于任务的方法，根据用户实际如何执行任务来编写。“当文档工程师告诉用户产品如何工作或内部结构时，他们很少能帮助用户”（Hargis et al. 2004）。以清晰易读的风格写作。使用足够的空白、表格和列表来构建和呈现信息，以便用户可以快速浏览信息。提供与用户环境或文化相关的示例（Carliner 2001）。回答用户可能对产品有“为什么”、“什么”和“如何”等问题。通过评审或测试文档来确保信息的准确性。消除冗余包括消除重复的信息、直观的屏幕截图和不增加价值的说明。例如，有经验的用户可能不需要显示用户界面的每个字段的屏幕截图。

开发阶段编写的信息的质量、准确性和呈现方式决定了用户能否“找到所需的内容”、“理解所找到的内容”和“使用所理解的内容”。

图 1 作为满足用户需求工具的信息设计

第三阶段：交付

在交付阶段，信息设计涉及根据用户访问信息的方式选择适当的交付媒介。

如果用户无法在需要时访问产品文档，那么即使计划和编写得再好，也毫无用处。例如，如果在只能在安装后访问的联机帮助中提供安装信息，则此类信息对用户来说没什么用处。

因此，文档工程师必须仔细决定交付的文档格式，以便用户能够在需要时“找到他们需要的东西”。

信息设计如何满足用户需求

图 1 显示了信息设计如何与文档生命周期联系在一起，以及每个阶段执行的活动如何满足特定的用户需求。

如果用户无法访问产品文档，无论多么精心策划和编写，也毫无用处

开发阶段是关键阶段，它对于满足用户的所有需求起着重要作用。也许这就是为什么管理者（有时是文档工程师）低估了文档规划的重要性并关注开发过程，尤其是在时间或预算有限的情况下。

然而，文档工程师绝不能忽视设计和交付阶段的重要性。设计阶段是开发的基础，而信息则通过交付媒介传达给用户。这些阶段显然增强了用户“找到他们需要的东西”的可能性。如果用户找不到信息，就无法理解和使用信息。因此，即使文档工程师在创建产品文档时无法遵循完整的流程，但为信息设计的每个阶段提供一些思考也是有益的。

参考文献ISO/IEC/IEEE 26514:2022 系统和软件工程-为用户设计和开发信息Burnett RE (2001)技术交流，Harcourt 出版社，第 5 版。Carliner S. (2001)文章：物理、认知和情感：信息设计的三部分框架。Hargis, G.、Carey, M.、Hernandez, AK、Hughes, P.、Longo, D.、Rouiller, S. 和 Wilde, E. (2004)。开发高质量技术信息： 文档工程师和编辑手册，第二版，Prentice Hall。Redish JC (2000)什么是信息设计？，技术交流，2000 年 5 月，第 47 卷。Schriver KA (1997) 文档设计中的动态：为读者创建文本，Wiley。Sless D. (1994)为人们设计信息，澳大利亚传播研究所，第 2 版。