完整

涵盖所有支持用户任务的主题，仅限于那些主题

Cover all topics that support users’ tasks, and only those topics.

技术信息的用户需要了解如何使用产品来完成工作任务。这个指南与任务导向的质量特征相关，因为在明确用户并评估这些用户要执行的任务之前，你无法决定涵盖哪些主题。通过了解用户及其任务，你就知道哪些主题是相关的。最基本的任务主题包括主要任务的描述、它们的子任务、执行它们的原因或条件，以及如何应对预期的错误。在写作项目的早期阶段，进行任务分析以确定用户需要执行的任务和子任务。项目后期，你可以使用任务分析来评估你的信息是否涵盖了必要的主题：

你是否涵盖了所有主要的用户任务？
你是否描述了用户完成主要任务所需的所有子任务？
你是否解释了与可选任务相关的原因或条件？
你是否描述了如果出现问题应该怎么做？

如果这些问题的答案都是肯定的，你的信息更有可能涵盖用户所需的所有主题。

有时，您需要在介绍一个主题、解释一个过程或强调优势时解释概念。不要将概念与关于产品内部的信息混淆。概念有助于用户学习，因为它们提供了必要的词汇或大局的方面。例如，在文字处理程序中，文件夹是一个概念，但该程序如何在内部表示和操作文件夹对用户来说并不感兴趣。

即使是真正的概念性信息，您也必须确保用户确实需要它。问问自己用户将如何使用这些信息。例如，这些信息是否有助于用户做出决策或完成手头的任务？当用户安装产品时，他们可能需要关于安装选项的信息，以便他们可以决定需要哪些选项以及选择哪些值。当他们在网上购物时，他们需要关于运输选项的成本和时间的信息，以便他们可以评估其购买的总成本，并确定购买是否会按时到达目的地。与用户任务无关的信息可能是多余的。

覆盖每个主题时，提供用户所需的详细信息，不多不少

Cover each topic in just as much detail as users need.

包含一个主题并不一定意味着你已经充分涵盖了它。目标应该是提供足够的详细信息，使用户能够完成他们的任务，但不提供比他们所需更多的细节。在分析任务时，你可能无法预测所有任务的细节；在后期写作时，关于细节的问题可能会出现。

关于详细信息的完整性判断通常比判断是否包含某个主题更主观。例如，决定是否包含有关故障排除的主题很容易，但确定是否描述很少发生的错误情况就不那么简单。将自己置于用户的角度，通常能够做出关于需要多少详细信息的良好决策。

为了了解需要的信息，你必须了解一些关于你的受众的信息。例如，你的用户是否熟练使用你的产品或类似的产品？了解受众的经验水平有助于确定哪些信息是相关的。

当你的受众是同质的——要么全部有经验，要么全部没有经验——时，写关于产品的信息最容易。一方面，如果你的信息涉及一款新产品，你可以假设你的受众至少在这个产品上是新手。另一方面，如果你的信息涉及一款在市场上存在很长时间、相对较少吸引新用户的老产品，你可以假设大多数受众都是有经验的。

如果你的受众经验水平各异，你需要决定如何满足各种信息需求，而不给任何群体带来问题。以下是一些可能选择的方法：

创建独立的概念、任务和参考主题。从任务主题链接到概念和参考主题，使用户无论经验水平如何都能获取他们所需的信息。
主要面向有经验的受众编写在线和印刷信息，但提供广泛的在线帮助来辅助新手。
将信息以两种不同的格式呈现，例如为有经验的用户提供高级主题，为新手提供教程。
在一个在线信息系统或一个印刷文档中整合信息，但将入门主题与高级主题分开（例如，放在不同的窗口、章节或部分中）。
整合信息，但在不同经验水平的信息之间进行图形区分，例如为有经验的用户提供带标签的提示或快捷方式。一些书籍将专业技术细节放在专用框内，有时称为侧栏，使用特殊的图标吸引用户的注意。

在了解你的受众之后，使用以下准则来确保涵盖每个主题所需的详细信息：

包含足够的信息。
只包含必要的信息: 过多的信息也会导致完整性问题。不必要的细节会减缓用户的速度，使得寻找和使用所需信息变得更加困难。

使用信息模式以确保适当的覆盖

Use patterns of information to ensure proper coverage

通过分析用户任务并使用和测试信息，您可以消除不必要的信息并识别冗余。确定是否已涵盖所有相关主题和细节的另一种方法是制定信息结构的模式。

您应用于信息的一种模式来自基于行业、公司、组织政策或法律的约定或标准。例如，书籍通常包括一些构成信息框架的标准部分，如封面、版权和其他法律声明以及目录。网页通常需要标准的页眉和页脚。标准部分只提供一个框架。信息内的模式帮助用户熟悉组织方式，使他们能够专注于他们需要的内容。制定模式的良好方法是从以下问题开始：用户需要完全理解一个概念需要什么？用户需要了解如何执行任务？用户需要了解如何使用参考信息？通过回答这些问题，您可以为概念、任务和参考主题定义一个模式。对于任务主题，模式可能是：标题、介绍、先决条件、任务步骤、相关任务链接。

确定信息模式后，您可能选择创建一个模板。模板是一种结构化的模式，对于确保包含所有平行或相似主题的标准部分非常有用。模板就像一个饼干切割器，用于以一致的方式复制标准对象。

只有在用户会从中受益时才重复信息。

Repeat information only when users will benefit from it

重复有时是好的，有时是不好的。适当的重复有益于强调和加强重要观点，或者使用户避免不必要地跳到另一个主题或页面。在Web上，当您不知道用户可能从何处进入您的信息时，重复也是好的。不必要的重复是不好的；多余的细节浪费阅读时间，可能会给人错误的印象，让人误以为某些内容很重要。