Easy to understand - Clarity
清晰
大多数作者第一次尝试写作时，文字并不清晰。通常，为了突破障碍，作者会像说话一样写作，但这种方法会引入问题，如不必要的词语、模糊的指代和冗长的句子。在说话时，人们可以通过视觉和听觉线索来理解，但书面文字必须独自传达信息。
清晰的信息主要是重写的结果——替换、添加和删除部分以实现清晰度。清晰的信息需要密切关注词语、短语、句子、列表和表格等要素，以确保每个要素在信息中得到适当的参与。这种关注在重写时可能比初次写作时更有帮助。
清晰性为许多关于文体和视觉效果的决策提供了基本原理。例如，您可能选择对某些词语使用粗体，对某些其他用途使用斜体；始终应用这些文体决策可通过使信息更容易被用户第一次理解而增强清晰度。
传统上，技术写作中实现清晰度的指南主要基于经验和对以英语为母语的人，尤其是美国英语的使用者的研究。然而，由于在Web上技术信息的激增以及技术信息在全球范围内的增加使用，技术作者必须对国际受众对清晰英语的需求也保持敏感。
清晰度的一些方面还涉及完整性（尤其是相关性和信息过多）和组织（尤其是一致性和从属性）的一些方面。清晰的信息需要强调用户需要了解的内容以及何时需要了解。多余的信息会混淆信息。信息要素之间的关系（无论是在句子、列表、表格或其他要素中）必须清晰。
要使信息清晰，请遵循以下准则：
- 关注意义。
- 避免模糊性。
- 保持要素简短。
- 以连贯的方式写作。
- 以相似的方式呈现相似的信息。
- 仅在必要和适当的情况下使用技术术语。
- 对受众不熟悉的每个术语进行定义。
关注意义
Focus on the meaning
清晰的信息要求你专注于你想说的内容。重点是什么？你希望用户做什么或知道什么？
| Imprecise Verbs | Precise Verbs |
|---|---|
| be in agreement | agree |
| be capable of | can |
| carry out an inspection of | inspect |
| conduct an investigation of | investigate |
| do a verification of | verify |
| draw a conclusion | infer, conclude |
| give an answer | answer |
| give rise to | cause |
| have a requirement | require |
| have knowledge of | know |
| have plans | plan |
| have the capability to | can |
| hold a meeting | meet |
| keep track of | track |
| make a distinction | distinguish |
| make a proposal | propose |
| make a suggestion | suggest |
| make changes to | change |
| make contact with | meet |
| perform the printing | |
| provide assistance | help |
| reach a decision | decide |
| render inoperative | break |
| serve to define | define |
| show improvement | improve |
避免歧义
Avoid ambiguity
为了避免你写的内容存在歧义，请遵循以下准则：
- 使用明确含义的词语。
- 避免模糊的代词。
- 适当放置修饰语。
- 避免冗长的名词串。
- 使用肯定语气。
- 使句子的语法清晰。
使用含义明确的词语
Use words with a clear meaning
当一个词有多个含义时，在上下文中有多个含义符合条件时可能会引起混淆。一些有歧义的词虽然很小，但在传达有关子句之间关系的信息方面却很重要。
| Ambiguous | Clear |
|---|---|
| as | because |
| as long as | if |
| in spite of | regardless of, despite |
| may | can, might |
| once | after, when |
| on the other hand | however, by contrast |
| since | because |
| through | finished |
| while | although, whereas |
避免模糊的指代
Avoid vague referents
对于翻译者和非母语人士而言，另一个影响清晰度的问题是模糊的指代。有时，当作者使用代词指代名词时，由于以下任何原因，名词可能变得模糊：
- 它离代词很远，也许在另一句中。
- 它与其他可能符合所指的名词混在一起。
- 它没有明确陈述。
适当放置修饰语
Place modifiers appropriately
修饰语包括介词短语、关系从句以及形容词和副词。
避免过长的名词串
Avoid long strings of nouns
英语语言允许将名词用作形容词。这种用法有助于英语提供新的术语，但当多个名词组合在一起时，也可能导致歧义。
软件或硬件功能的名称似乎特别容易出现名词的组合，例如“work load”、“table space”、“error message”、“access key”和“procedure call”。随着时间的推移，一些成对的名词变成一个词，如“database”和“workstation”。
三个名词组成的串在功能和功能的名称中很常见，例如“program request handler”、“attribute properties window”和“network terminal option”。这些组合可能导致对修改什么的混淆。例如，程序请求的处理程序，还是请求处理程序是为了程序？中间的名词与第一个名词还是最后一个名词配对，还是三者相等？
如果三个名词中的第一对作为第三个名词的形容词，考虑使用连字符，如“character-set identifier”。然而，如果组合已经确立为不使用连字符的形式，您需要遵守该惯例。
使用肯定语气
Write positively
在句子中使用多个否定词可能使句子难以理解。如果在一个从句中放入两个否定词（例如“not unlike”），将使该从句变为肯定句。研究表明，读者更难理解具有双重否定的句子，而不是等效的肯定句。
| Negative Expressions | Positive Expressions |
|---|---|
| not many | few |
| not the same | different |
| not different | similar |
| not unlike | like |
| not exclude | include |
| not … until | only when |
| not … unless | only if |
| Negative Expressions | Preferable Expressions |
|---|---|
| does not have | lacks |
| does not allow | prevents |
| does not accept | rejects |
| not able | unable |
| not possible | impossible |
使句子的语法清晰
Make the syntax of sentences clear
一些词语（如连词、冠词、介词和关系代词）本身的意义较小，但它们将句子的更重要的部分粘合在一起。这些所谓的句法线索帮助用户，特别是翻译者和非母语人士，理解句子中的单词之间的关系。例如，冠词（the、a、an）可以帮助用户识别一个名词，这可能是主语或宾语，取决于它与句子中的动词的关系。机器翻译系统也依赖于这些线索来分析信息。
保持要素简短。
Keep elements short
冗长的文字浪费阅读时间、空间和纸张，有时会掩埋信息。在Web上，文字简洁尤为重要，因为阅读速度比印刷材料慢25%。
去掉迂回的表达和不必要的重复
Remove roundabout expressions and needless repetition
迂回的表达使用了多个词，而一个或两个甚至没有词就足够了。在口语中，人们通常使用额外的词汇来争取时间思考下一句要说的话。然而，在书写中，这些多余的词汇就像噪音一样，阻碍了表达的意义。
| Roundabout Expressions | Concise Terms |
|---|---|
| at present | now |
| at this (that) point in time | now (then) |
| a variety of | various (maybe different, many, several, or nothing) |
| due to the fact that | because |
| during the course of | during |
| for the most part | usually |
| for the purpose of | for |
| given the condition that | if |
| in an efficient manner | efficiently |
| in case of a | in a |
| in conjunction with | with |
| in order for | for |
| in order to | to |
| in the event that | if (or when) |
| of an unusual nature | unusual |
| on account of the fact that | because |
| with regard to | about |
| Needless Repetition | Succinct Expressions |
|---|---|
| adequate enough | enough (or adequate) |
| by means of | by |
| create a new | create a |
| end result | end (or result) |
| entirely complete | complete |
| every single | every (or single) |
| exactly the same | the same |
| group together | group |
| integral part | part |
| involved and complex | complex |
| is currently | is |
| new innovation | innovation |
| one and only one | one |
| period of time | period (or time) |
| plan in advance, advance plan, planning | advance plan, planning |
| refer back | refer |
| repeat again | repeat |
| share in common | share |
| sequential steps | steps |
| subject matter | subject |
| summary conclusion | summary (or conclusion) |
选择直接的词语
Choose direct words
保持列表简短
Keep lists short
长列表，尤其是任务或子任务的长列表，可能会让用户感到不知所措。用户在完成任务的步骤或子任务时，往往更容易保持乐观的态度，如果这些步骤或子任务没有没完没了的延续。用户需要理解整个任务，并看到各部分如何贡献。至少，在用户阅读任务或子任务的步骤时，他们应该能够在不断地回头查阅信息的情况下完成这些步骤；他们应该能够记住他们读过的信息足够长的时间以在即时情况中使用。理想情况下，只需查阅一次任务主题的用户应该能够在更长的时间内记住这些步骤，而且如果需要再次执行任务，则不需要再次查阅相同的主题。
短时记忆（也称为即时记忆或工作记忆）被认为是人们在将信息转移到长时记忆之前暂时存储信息的一种记忆类型，或者是在忘记信息之前。1956年George Miller报告的关于短时记忆的研究表明，人们可以记住七个项目，加减两个。此后的研究表明，短时记忆的容量较小，可能为四到六个项目（根据1975年Broadbent的说法），四个项目（根据1987年MacGregor的说法）或三个项目（根据1999年LeCompte的说法）。
这些几十年来研究短时记忆的结果的变化是否表明对不变的短时记忆能力的改进研究？另一个解释可能与我们学校对记忆的弱化有关，学生接受的任务较少（如记住所有首都或乘法表）涉及将项目从短时记忆转移到长时记忆。另一个解释可能是人们更多地依赖机械记忆，如计算器和个人数字助手，用于两种类型的记忆。
无论对短时记忆研究结果的下降趋势是否显示出对研究的改进，对精神能力的衰退，对机械记忆的更大依赖还是其他现象，技术信息的编写者必须帮助用户记住即使是少量的项目，尤其是用于短期使用的情况。用户第一次能够更好地理解步骤，如果他们想记住信息，他们就更容易实现将其转移到长时记忆中。
关于用户需要记住的列表中项目数量的传统指导方针是：
- 在线信息的最大项目数为七个
- 印刷信息的最大项目数为九个
写作要有连贯性
Write cohesively
单独看待的元素，如句子、列表、表格、图表和示例，不一定能产生总体上清晰的信息。这些元素必须共同协作，以突出你想传达的最重要的观点。每个元素中表达的观点不应具有相等的权重。相反，一些观点应该加强其他观点，从而对信息的整体影响产生贡献。
以类似的方式呈现相似的信息
Present similar information in a similar way
为了以类似的方式呈现相似的信息，请遵循以下指导方针：
- 适当使用列表。
- 将信息分段为表格。
适当使用列表
Use lists appropriately
根据信息的性质选择列表类型。对于序列或优先级重要的信息，请使用有序列表。在技术信息中，程序中的指令是有序列表的最常见用法。对于相似重要性的项目，例如一组替代方案或零件，请使用无序列表。
将内容分段为表格
Segment information into tables
与列表类似，表格可以有效地以类似的方式呈现相似的技术信息。
仅在必要和适当的情况下使用技术术语
Use technical terms only if they are necessary and appropriate
只要有可能，合理地避免引入专业术语。除非新术语真的能帮助用户，否则它只是他们需要学习的又一项内容。为了仅在必要和适当的情况下使用技术术语，请遵循以下指导方针：
- 决定是否使用术语。
- 一致使用术语。
决定是否使用术语
Decide whether to use a term
在决定术语是否必要和适当时，请考虑以下因素：
是否已经存在适当的术语来命名您想要命名的事物？
如果已经存在广泛使用和被接受的术语，请使用它。即使您有替换技术术语为非技术术语的冲动，也无需创造新术语。
您是否打算仅使用术语一两次？如果是这样，您可能可以使用一个描述性短语代替。
除非您会经常使用首字母缩写，并且所代表的短语难以处理，否则不要创建首字母缩写。
一致使用术语
Use terms consistently
如果您确定需要一个术语，请仔细选择它，引入它，并一致使用它。如果您领域的一般文献对相同的事物使用两个或更多个术语，请选择一个并保持一致使用。在某些写作中，鼓励您为同一事物使用不同的词汇以增加变化。然而，在技术写作中，对同一事物使用超过一个术语会引起混淆。两个术语暗示着两个不同的事物。
为目标受众新的术语进行定义
Define each term that is new to the intended audience
在所有写作中，作者与信息使用者之间的交流依赖于它们共同拥有的词汇。当用户首次遇到新主题时，它可能看起来像一门外语，有着自己的词汇和结合这些术语所表达的概念的规则。例如，英语的母语使用者如果从未开发过计算机应用，第一次尝试使用应用程序开发工具时可能会感到像在外国一样迷失。
有些术语可能是熟悉的，但它们的定义可能与用户的预期不同。例如，Object 和 Class 这两个词是熟悉的，但在面向对象编程中它们有着特殊的含义。
对于用户而言，新的或与他们预期的使用方式不同的术语需要进行定义。这些术语包括首字母缩写和其他缩写。在首次使用新术语的文本中，以有意义的方式解释该术语并进行突出显示。尽量避免在此之前使用该术语。
为帮助用户识别您使用的术语和定义，突出显示新术语。在在线信息中，您可以通过链接提供定义。弹出式帮助（或气泡帮助）对于呈现定义非常有效，因为用户可以在同一主题中阅读定义的同时保持不变。您还可以从首字母缩写链接到它们所代表的术语。然而，在在线信息中，如果用户在同一主题中给出术语之前仅使用首字母缩写，或者该首字母缩写为常见理解的，则用户可能更容易理解首字母缩写；您不能确定用户是否已经看过解释首字母缩写的另一主题。
在印刷信息中，在首次使用新术语的地方包括定义，并将术语放入术语表和索引中。如果一个术语有您使用的首字母缩写或缩写，拼写出该术语的第一次出现，并在括号中跟随首字母缩写或缩写。