技术写作标准

缩略语

缩写是单词的缩写形式，如美国机械工程师协会的ASME。缩写词是由缩写词构成的可发音单词，如北大西洋公约组织的NATO。

缩略语和首字母缩写词应在第一次出现在技术文件中时拼写出来，缩写形式应紧跟在术语后面的括号中。然后，缩写或首字母缩略词可以在整个论文中使用。

例如：技术传播学会（STC）是一个致力于技术传播、内容和信息管理进步的专业协会。

通用缩写词（美国）或首字母缩写词（NASA）在文档中首次使用时不需要拼写出来。

二义性

当单词或段落可以用多种方式解释时，就会出现歧义。抽象语言、错位修饰语和模糊代词指称都可能导致歧义。要使书写清晰，请避免：

• 抽象语言(真的，相当，严重，非常)
• 过度使用代词，尤其是它，这些，和这
• 不准确或主观的术语(快、慢、高、小)
• 没有确切含义的单词(一点)

示例：

模棱两可的：

“前向偏置硅二极管的电压很小。”

清除：

“正向偏置硅二极管的电压为0.7 V。”

模棱两可的：

“因为参议员马丁对环境的兴趣不如对经济发展的兴趣，所以他有时会忽视这一点。”

清除：

“由于参议员马丁对环境的兴趣不如对经济发展的兴趣，他有时会忽视环境。”

模棱两可的：

“我建议你稍微增加利润。”

清除：

我建议您将毛利增加0.25英寸。”

模棱两可的：

“今年的加薪比去年少了一点。”

清除：

“今年的加薪比去年少0.5%。”

类比与隐喻

类比和隐喻在科技写作中很有用，通过比较两种通常不同的事物来说明抽象或复杂的思想。

例子：

“当两个原子以极快的速度相互接近时，它们会相互穿过，而在中等速度时，它们像两个台球一样相互束缚。”

布瑞格爵士

观众

把目标读者放在心上写作是科技写作最基本的概念之一。许多技术文件不仅由第一人称（主要读者）阅读，也可能由第二人称阅读：各级管理层的读者、潜在的金融家，甚至是在作者不知情的情况下获取信息的个人。

因此，重要的是要考虑谁可以在主要读者之外阅读您的文档，并在写作时考虑其他读者。这意味着以适合受众知识的信息为目标，并使用技术和非技术受众都能理解的易用语言。

陈词滥调

Cliches或修辞格是没有具体含义的术语，可能会影响文档的语气和专业性。在技术写作中应避免出现裂缝。示例包括：

示例：

• 桥下的水
• 在墙上写字
• 说起来容易做起来难
• 完成交易

简洁

简洁的文档使用尽可能少的单词传达意思，而不牺牲含义或清晰度。要做到简洁：

• 消除空洞/冗长的短语(有和它是). 这些被认为是间接短语，往往不清楚且冗长。另一方面，直接的陈述是明确和简洁的。

  而不是：

  “有25名学生已经对明年的计划表示了兴趣。”

  使用：

  “25名学生已经对明年的计划表示了兴趣。”

• 使用主动语态书写

  而不是：

  “确定机器是约翰弄坏的。”

  使用：

  “约翰把机器弄坏了。”

• 避免使用弱动词

  而不是：

  我的建议是增加预算。

  使用：

  我建议增加预算。

• 消除填充词（非常、相当、真的、有点）

收缩

缩略语是单词的缩写形式，缺少的字母由撇号表示，例如“you'll”表示“you will”，“didn't”表示“didn not”。缩略语是不专业和非正式的，在大多数技术文档中应避免使用。

通用语句

泛化是应用于一群人或事物的宽泛陈述或观点，在科技写作中应避免使用。这些陈述难以证实，而且内容过于广泛，无法得到支持。

示例：

学习另一种语言的唯一方法是访问使用它的国家。

猫比狗好。

性别中性词

尽可能避免指定性别。针对性别的语言可能会造成刻板印象、泛化和排斥性别。个人不应仅被称为他或她.实现性别中立：

• 在提及特定人群（“主管”）时使用通用术语
• 避免使用特定性别的代词（“his”或“her”）
• 提及人时使用中性标题“（销售代表”而不是“销售人员”

示例：

• 学生应该总是做作业。（不是性别中立）
• 学生应该总是做作业。（性别中立）
• 学生应该总是做作业。（性别中立）
• 学生应该总是做作业。（性别中立）*

*虽然使用复数可能看起来很奇怪或不正确他们的指的是一个学生，他们的已成为许多地方的首选替代品，以确保语言中性。它不再被认为是语法错误的用法他们的作为单数代词。

标题

在技术报告中，标题用于组织文档，指导读者，并将内容分解为可管理的信息块。读者经常阅读标题并阅读与之相关的章节。

标题将内容组织成大的部分（主要标题），然后再组织成小的部分（子标题）。标题按级别（第一级、第二级、第三级等）设置格式，其位置和格式各不相同。专业和雇主专用风格手册将为标题的放置和视觉布局提供指导。标题因其提供的信息类型而异：

• 简短的主题标题使用简短的单词或短语
  

  例子：

  大学申请

• 陈述标题使用句子或短语，更具信息性。

  例子：

  大学申请流程

• 在编写解释如何做某事的文档时，问题标题很有用。

  例子：

  我如何申请大学？

使用标题时：

• 以平行方式构建标题
• 尽量避免以开头a、 an或
• 每个级别至少有两个标题；如果可能的话，避免将一个部分划分为一个子部分
• 避免在副标题中重复较高级别标题的措辞
• 使用标题创建目录（如果适用于文档）

行话

行话通常被称为专业俚语，由特定组织的特定术语组成。术语的例子包括“火焰”或“FUBAR”。术语将组织成员与非成员区分开来。当与可能不熟悉行话的人交流时，避免使用该术语。

列表

列表在技术写作中有三个用途：编写一系列相关项目，描述一系列任务，以及使项目可视化。列表可以写在一个句子中（如前一句所示），也可以从文本中垂直隔开。垂直列出的项目以项目符号、数字或复选标记开头。项目符号列表使项目易于查看或定位，编号列表组织流程中的步骤，而复选列表传达需要或需要完成的项目。

列表以引入短语开头(培训审查项目：)或句子(培训中将回顾以下主题：)

创建列表时要记住的要点：

• 列表应以并行方式构建。
• 由简短项目组成的列表通常不包含结束标点符号。
• 不需要顺序的列表应按逻辑排列（从最重要到最不重要，按字母顺序排列）
• 写为完整句子的列表应使用适当的结束标点符号。

叙述（观点）

写作时，使用适当的时态和叙述很重要。工程师经常写信解释怎样发生了一些事情：实验室程序、现场考察、事故、建议。

第三人称叙述通常是技术文档和学术期刊中的适当选择，但在某些情况下，使用第一人称或第二人称可能是合适的（在商业信函中常见）。

示例：
第一人称叙述，使用了“I”字。
我应该在大学里取得好成绩。
我们应该在大学里取得好成绩。

第二人称叙述，使用“You”单词。
你应该在大学里取得好成绩。

第三人称叙事使用“他/她/中性”词。
学生应该在大学里取得好成绩。

学生应该在大学里取得好成绩。

客观性

技术文件呈现事实、数据、证据、计算、结果和理论，必须以客观、中立和客观的方式呈现。在科技写作中避免使用单词“feels”或动词“feel”。

像“我觉得这是最好的方法”这样的短语会引起情感，不是客观的，并且会给技术写作带来不确定性。同样，“当重量感觉合适时”不应用于描述无生命物体。

段落

段落是文件的组成部分。重要的是要记住段落结构的基本要素：每个段落都应该包含一个发展良好并得到支持的主题句，讨论一个想法，并过渡到下一段。

在科技写作中，段落通常保持在4-6行。短段落强调主要思想，鼓励简洁，保持读者的注意力，并将内容分解为易于管理的块。

并行性

并行性意味着对列出的项目使用相同的结构。这些项目可以出现在句子、表格、项目符号或编号列表或标题中。平行结构的句子更容易阅读，流畅。

非平行：

“在传热和传质课上，学生们学习了建模热方程、热设计尺寸标注以及如何分析结果。”

平行：

“在传热传质课上，学生们学习了建立热方程模型、热设计尺寸标注和分析结果。”

创建项目符号列表时，列表中的所有项在结构上都应该是并行的。

冗余

冗余意味着使用两个或两个以上基本上表示相同意思的单词。冗余会影响简洁性。

SI与常用单位

国际单位制（SI）单位是最广泛和官方认可的公制单位制，用于度量重量、尺寸和其他技术文字中的物理测量。技术文件应在文本、数字、表格和方程式中使用国际单位制。

句子长度

在科技写作中，简单的句子用来表达复杂的思想。长而复杂的句子往往会使读者感到困惑。争取10-20个单词的句子长度。然而，文档不应该由短小、断断续续的句子构成。改变句子长度可以提高可读性、进行比较和对比信息。

技术术语和定义

在文档中引入技术术语时，应使用斜体，并在首次使用时对术语进行简要解释。技术定义通常有三种类型：非正式、正式和扩展。

非正式定义包含一个单词或简短短语，通常放在括号中，提供有关该术语的最少信息。

形式定义通常是一个完整的句子，用于区分术语与其他类似术语，包括术语本身、术语所属的类别以及术语的区别特征，这些特征通常描述术语的作用。

如果技术术语含义不明确或有多重含义，请在定义的开头添加一个限定词。

音调

语调是指一份文件唤起的感觉或态度；语调也可以描述作者对主题的感受。语调可以取决于信息的目的、受众或媒介。争取使用中性、专业、易懂的词语。因为工程师要处理复杂的信息和术语，所以单词的用法应该容易理解和熟悉。

语音（主动或被动）

语态是指动词在句子中的用法。虽然被动语态长期以来一直是科技写作的标志，但用主动语态写作是一种首选做法。主动语态使句子更加清晰简洁，从而使文档更具可读性。被动语音仍用于某些类型的技术文档，如实验室报告。

当动词处于主动语态时，主语执行动作；当动词用被动语态时，主语接受动作。

示例：

活动：

这个男孩击球了。

被动：

球被那个男孩打中了。

提示：注意被动语态常见的短语模式：“was（动词）ed by….”

在以下情况下使用主动语音：

• 编写大多数技术文档。
• 写作需要简洁、清晰、直接。
• 知道句子的“实干者”很重要。

在下列情况下使用被动语态：

• 体裁（格式）要求被动语态（实验报告）
• 行动本身比谁或什么人执行了行动或当行动的实施者未知时更重要。

单词选择

无论是初级还是次级受众，都应该使用容易理解和熟悉的词汇。这意味着使用一个较短、更知名的单词来代替具有相同含义的较长、不知名的单词。

示例：