准确

只有在你理解了信息后，才写下来，并在写作完成后进行验证

Write information only when you understand it,and then verify it.

当您发布信息时，您必须充分了解该主题，以便可以告诉用户他们需要了解什么。 有时你可以很快地理解这个主题，并且能够毫无困难地准确、清晰地写出它。 在其他时候，这个主题是新的并且没有很好的记录。

也许某个软件产品不可供您尝试，或者技术上专家无法在一开始就向您解释该主题。当你无法获得产品的第一手经验或无法获得技术专家的帮助时，你必须从你所了解的内容开始撰写初稿。

考虑在早期草稿中向专家提出问题，以征求您为用户微调信息所需的解释。 技术专家有时更擅长审查书面内容并找出不准确之处，而不是从头开始记录技术主题。 编写信息并根据需要多次对其进行审核，以确保在您发布信息时信息准确无误。

理解你所写的技术主题的最佳方法是像用户一样使用该产品。作为一名作者，你越多地使用产品、工具或界面，你就越能对信息的准确性负责。例如，当你编写基于两个表的数据库视图创建过程时，你可以使用界面来决定包含哪些步骤。然后，在完成过程编写后，你可以进行测试；如果成功创建了视图，你就知道过程是准确的。

当时间和条件允许时，请尽量通过以下一种或多种方式确保信息的准确性：

  • 安排一次非正式的可用性展示，你和其他作者使用信息执行一些或所有重要的用户任务。
  • 观察一次正式的可用性展示，在此过程中，实际用户使用信息以及相关产品、工具或界面执行某些任务。
  • 访问你信息的一个或多个用户，观察他们在日常任务中的操作。

这些活动可以增加你对用户如何完成工作的了解，从而能够编写准确的信息，使他们的工作变得更容易。

即使使用产品、工具或界面广泛并参与展示活动的作者，也必须寻求他人的反馈：

  • 技术审阅员审阅和验证技术信息的准确性。
  • 写作团队审阅和验证非技术信息（如样板文本）的准确性。

你可以在编写信息的小部分时非正式地征求这些反馈，也可以在进行审查或检查时正式地征求反馈。在编写技术信息之前，请确保你对主题有足够的了解，以便能够向用户解释他们需要知道的内容。在可能的情况下，在开发信息时使用产品、工具或界面，并始终在向用户提供信息之前验证准确性。

跟上产品迭代

Keep up with technical changes.

技术信息如果不是最新的，就是不准确的。信息可能在一个版本到下一个版本之间或在一个开发周期内过时。

每当发布信息的新版本时，请确保商标、产品名称和版本信息以及样板信息是最新的。尽量避免提及产品的具体版本级别，除非你有充分的技术理由，例如：

  • 强调新发布的产品版本或版本的营销信息
  • 适用于特定版本的限制

信息在产品的开发周期中，甚至在产品发布之前，也可能变得过时。例如，当规格文档可用时，作者需要将其中的信息纳入文档。然而，即使团队记录了设计的更改，该文档可能与实际产品不同步。变更逐渐增加，人们有时会忘记提及它们。确保你的信息准确描述了产品，方法之一是检查信息是否与用户将看到和体验到的内容相匹配。

当信息最终确定后，如果界面发生变化，包含显示用户界面全部或部分的图形可能导致准确性问题。

保持对一个主题的所有信息的一致性

Maintain consistency of all information about a subject.

许多准确性问题的发生是因为作者在一个地方更新了信息，但在出现该信息的其他地方没有进行相应的更新。当用户面对不一致的信息时，他们无法确定哪些信息是正确的。

当你确定某些信息需要逐字重复时，你可以利用确保信息一致性的最佳方式：重用信息。

信息的最简单重用形式涉及将信息从一个地方复制并粘贴到其他地方。只有在被重用的信息非常短且未来不太可能更改时，才选择这种技术。对于你不想逐字复制的较长主题，可以使用更好的重用方法：单一源。单一源指的是为不同的输出使用相同的源，几乎没有或没有变化。除非另有说明，在本书中使用的术语“重用”是指使用单一信息源，而不是复制信息。

尽量重用信息

Reuse information when possible.

通过重用共享信息，你确保用户不会对正确的信息感到困惑。而且，你只需要在一个地方进行信息更改。

避免引入不一致性，并消除发现的不一致性

Avoid introducing inconsistencies and eliminate those that you find.

确保信息一致性的一个很好的一般规则是尽量减少包含相同信息的地方的数量。

使用可以自动检查准确性的工具

Use tools that automate checking for accuracy.

尽管样式章节涉及排版和语法错误，但这些问题也可能影响信息的准确性。有许多工具可帮助作者识别排版和语法错误，以及其他类型的错误，如无效的交叉引用。

排版和语法错误可能会产生各种影响。当用户注意到一个小错误时，他们对信息的整体满意度可能会略微下降。如果他们注意到许多错误，他们可能会对技术信息的整体准确性产生疑问。如果错误出现在代码示例、用户过程、有效值陈述或语法定义中，用户可能会停止阅读信息，甚至停止使用产品。

检查与相关信息的引用的准确性

Check the accuracy of references to related information.

你需要特别注意以下类型的引用：

  • 对于 Web 位置的引用。为了帮助用户快速找到引用的 Web 信息，请使用该信息的具体 Web 地址。请记住，Web 地址有时会更改。如果你知道你无法经常验证这些地址是否有效并相应更新你的信息，请考虑同时包含负责目标信息的公司或组织的高级 Web 地址。
  • 对于印刷材料的引用。包括标题以及作者或出版商。