34、技术写作词汇使用指南

技术写作词汇使用指南

一、常见词汇使用规范

1.1 避免使用的词汇及替代建议

• quick key ：不建议使用“quick key”，建议使用“keyboard shortcut”。
• quit ：“quit”在以下几种情况不适用，需使用相应替代词汇：
  • 用户关闭程序，用“exit”。
  • 用户关闭文档或窗口，用“close”。
  • 程序遇到问题无法继续而自行关闭，用“close”（注意与“stop responding”区分，“stop responding”表示程序无法自行关闭）。
  • 结束计算机或网络上的用户会话，用“log off”。
  • 结束网络连接，用“end”。

1.2 特定词汇的使用说明

1.2.1 radio button

“radio button”对于全球受众来说是个有问题的术语。除了在应用程序编程接口包含该术语的软件开发内容中使用外，其他情况尽量避免。在软件开发内容中使用时，可表述为“ option button (also known as a radio button)”，若内容有索引，需将“radio button”列入索引并交叉引用“option button”。在其他内容中，通过其标签来指代“radio button”，若必须提供描述，用“option”，使用确切的标签文本（包括大小写），但“option”本身无需大写，通常应仅提及“radio button”所控制的选项，若为避免歧义必须提及按钮，用“option button”。

1.2.2 ragged right

可用于指文档中不整齐的右边缘，与“right - aligned”相反。

1.2.3 RAM

是“random access memory”的缩写，关于内存的表述指导可参考“memory”。

1.2.4 range selection

除非别无选择，否则不建议使用。对于普通受众内容，用“a range of cells”或“a range of dates”等短语来指代相邻单元格、日期等的选择；对于技术受众内容，描述该功能时用“adjacent selection”。选择多个不相邻项目称为“multiple selection”。

1.3 前缀“re -”的使用规则

一般情况下，以“re -”开头的单词无需加连字符，除非为避免混淆或“re -”后接专有名词。不确定时，可查阅《美国传统词典》或参考项目样式表。例如：
- “reenter”
- “recover（找回或重新获得）”
- “re - cover（再次覆盖）”
- “recreate（参与娱乐活动）”
- “re - create（重新创造）”

1.4 读写相关词汇

• read/write ：使用“read/write”代替“read - write”，如“read/write permission”。
• read/write permission ：用“read/write permission”代替“read/write access”，文件和设备有读写属性，而用户有访问这些文件和设备的权限。
• read - only ：始终使用连字符，如“read - only memory”“This file is read - only”。

1.5 实时相关词汇

“real - time”和“real time”，作为名词时为两个单词，作为形容词时加连字符。例如：“Real - time operations happen at the same rate as human perceptions of time.” “In chat rooms, users communicate in real time.”

1.6 reboot

不建议使用“reboot”，建议使用“restart”，并明确此处的“restart”指的是计算机而非程序。若用户界面或应用程序编程接口在标签或元素名称中使用了“reboot”，可原样复制标签或元素名称，但描述动作或事件时用“restart”。

1.7 recommend

可以直接使用“we recommend”进行推荐，但并非必需，也可使用其他表达方式。当某事为必需时，不要使用“recommend”。避免使用“Microsoft recommends”，它会带有不恰当的企业口吻，可能被一些用户视为傲慢；也不要使用“it is recommended”，它听起来既像企业用语又含糊其辞。

1.8 Recycle Bin

前面需加定冠词“the”，如“the Recycle Bin”，在Windows中，它是删除文件的临时存储处，直到文件被永久删除。

1.9 refresh

“refresh”用于指更新网页，描述屏幕上图像恢复或数据更新动作时，使用“redraw”或“update”。提及“Refresh”命令时，可用“To update the screen, click Refresh.”

1.10 registry, registry settings

“registry”是存储用户、安装程序和应用程序以及特定硬件配置数据的数据库，具有层次结构。路径的第一级称为“subtree”，下一级称为“key”，“key”以下的所有级别为“subkey”。“registry”一词除作为命名系统组件（如“Registry Editor”）的一部分时大写外，其他情况用小写。一级子树由系统定义，全部大写，单词用下划线分隔，通常加粗；“key”由开发人员定义，通常全部大写或大小写混合，无下划线；“subkey”通常大小写混合。整个“subkey”路径称为“subkey”，而非“path”。对于“subkey”，“Name”列中的项目是“entries”，“Data”列中的项目是“values”。

1.11 reinitialize

“reinitialize”不能用来表示“restart”，参考“initialize”。

1.12 release notes

提供产品测试版和公测版的相关信息。

1.13 REM statement

“REM statement”是“remark statement”的缩写，是Visual Basic和其他一些程序中注释的术语，不要泛泛地用来指代注释，使用“comment”。

1.14 remote

作为形容词可用于描述另一个站点的人或计算机；在编程中，“remote computer”通常指与运行程序的计算机直接或间接连接的计算机。不要用“remote drive”描述远程计算机上的磁盘驱动器，用“network drive”；“remote”除指遥控器（如电视机遥控器）外，不要用作名词，也不要用作动词。

1.15 remove

“remove”不能用来表示“delete”，在以下技术语境中使用正确：
- 指在有“Add”和“Remove”按钮的对话框中从列表中移除项目。
- 指从工具栏移除按钮，或隐藏显示的数据而不删除数据（如Windows资源管理器中的列）。
- 作为“unload”的同义词。
- 在讨论添加而非安装软件或硬件的语境中，作为“uninstall”的同义词。

1.16 replace

“replace”只能用作形容词或动词，不能用作名词。一般用“replace”代替“overwrite”表示替换文件。

1.17 restore

作为动词，可用于指代恢复已删除的项目，或描述将项目或状态恢复到先前状态（如将窗口恢复到最小化状态）。在面向普通受众的内容中，除遵循用户界面使用外，不要用作形容词或名词。“Restore button”指窗口右上角靠近“Close”按钮、带有两个窗口图像的按钮，不要使用“Restore box”或“Restore icon”，“Restore”作为“Restore button”的一部分始终加粗，点击该按钮可将文档恢复到先前大小。在SQL Server中，“restore”用于指恢复一系列一个或多个数据库备份，除非别无选择，否则不要用作名词，必要时可用作形容词，如“restore operation”或“RESTORE statement”，但最好仅用作动词。

1.18 right

不要单独用作方向术语，使用“upper right”“lower right”“rightmost”或“the right side of”等术语，修饰名词时加连字符，如“upper - right corner”，不要使用“right hand”。在考虑可访问性时，避免仅使用方向术语（左、右、上、下）作为位置线索，认知障碍者和依赖屏幕阅读软件的盲人可能难以理解。若同时包含其他位置指示（如在“Save As”对话框中、在标准工具栏上或在标题栏中），方向术语可以使用；当有阅读障碍的视力正常用户能清楚看到操作导致的界面变化（如点击左窗格中的选项时右窗格发生变化）时，方向术语也可以使用。

1.19 right align, right - aligned

用于指文本右对齐，“right - aligned”在句子中任何位置都要加连字符，不要使用“right - justified”。

1.20 right mouse button

在大多数内容中，使用“right mouse button”代替“secondary mouse button”“mouse button 2”等术语，尽管用户可以对鼠标按钮进行编程切换，但可用性研究表明，大多数用户理解这个常用术语。

1.21 right - click

用于描述点击鼠标辅助按钮（通常是右键），在面向计算机新手的内容中，必要时需定义该术语。

1.22 rightmost

为一个单词，用于指代最右侧的事物，避免使用“farthest right”“far - right”等类似术语，可访问性考虑参考“right”。

1.23 rights

“rights”仅以非特定方式指代系统管理员授权的系统操作，具体指代时使用“user rights”。不要将适用于系统操作的“rights”与适用于特定系统资源（如文件或打印机）的“permissions”混淆，也不要用“privileges”作为“rights”的同义词。

1.24 rip

避免用“rip”表示将音乐或视频从CD或DVD传输到硬盘，若必须使用，首次提及时进行定义，并提供词汇表条目。

1.25 ROM

是“read - only memory”的缩写，关于内存的表述指导可参考“memory”。

1.26 root directory

使用“root directory”指代所有其他目录或文件夹分支出来的目录或文件夹（在MS - DOS中用反斜杠“\”表示），不要使用“home directory”，当指目录时不要缩写为“root”。

1.27 RTFM

“RTFM”是“read the manual”的缩写，有时会被解读为使用粗口，不要使用。

1.28 running foot, running head

不建议使用，建议使用“footer”和“header”，若为澄清或作为关键词、词汇表条目使用则可以。

1.29 run time, runtime, run - time

• “Run time”指应用程序运行的时间，如“You can enter and modify data at run time. During design time, you create objects and modify their design.”
• “runtime”是运行未编译为机器语言的程序所需的环境，不要将“runtime”用作阅读器程序（如Microsoft Office文件查看器）的同义词。
• “run - time”作为形容词描述在运行时发生或相关的事物，如“The common language runtime is a key element of the.NET Framework.” 在需要标题大写的上下文中，分别大写为“Run Time”“Runtime”“Run - Time”。

1.30 run vs. execute

面向普通受众的内容中，除遵循用户界面外，不要使用“execute”，使用“run”。若用户界面包含“execute”，用户或程序的动作仍用“run”，在宏和查询的上下文中始终使用“run”。在面向技术受众的内容中，“execute”尤其是在被动语态中可以使用，但在不造成含义损失的情况下，“run”更可取。

1.31 runs vs. runs on

计算机“运行”操作系统（如Windows Server 2008）用“runs”，程序“在……上运行”操作系统用“runs on”。

1.32 (s), (es)

不要在单数名词后加“(s)”或“(es)”表示单复数均可，一般使用复数形式，但要根据语义判断。若需要同时表示单复数，使用“one or more”。

1.33 sample vs. preview

• “sample”是某物可能在屏幕上显示的图形表示，并非用户正在处理的文件内容的精确表示。
• “preview”是用户在屏幕上确切看到内容的图形表示。

1.34 save

“save”不能用作名词，使用“Before you turn off your computer, save your files.”，而不是“Before you turn off your computer, do a save of your files.”。“save”常与以下介词搭配：“save on a disk”“save to a file”“save for a rainy day”。

1.35 scale up

一般使用“scale up”代替“upsize”，尽管“upsize”在客户端/服务器产品中已很常见。

1.36 scan line

为两个单词，指扫描设备读取的像素行或显示屏上的水平线。

1.37 screen

使用“screen”代替“screenful”或“full screen”，但可以说程序在“full - screen mode”下运行。“screen”用于指视觉输出设备的图形部分，“display”作为视觉输出设备（如平板显示器）的通用术语，参考“display”“monitor”。

1.38 screen resolution

屏幕分辨率使用“number × number”格式，如“640 × 480”，而不是“640 by 480”，使用乘号“×”而非字母“x”。

1.39 screened subnet

除首次提及“perimeter network”时，将“screened subnet”放在括号中表述为“perimeter network (also known as DMZ, demilitarized zone, and screened subnet)”外，后续使用“perimeter network”。若内容有索引或词汇表，将“DMZ”“demilitarized zone”和“screened subnet”列入并交叉引用“perimeter network”。

1.40 ScreenTip

是屏幕上出现的任何提示（如“tooltip”）的通用术语，尤其用于Microsoft Office相关内容。

1.41 script, scripting language

尽可能泛泛地指代脚本，即提及代码时直接使用“script”。

1.42 scriptlet

仅用于指代名为“scriptlet”的Web组件，其他情况使用“script”，必要时使用更具体的术语。

1.43 scroll

“scroll”不直接接宾语，使用方向信号词或介词。若滚动概念已明确，可使用“move through”等动词短语。用户通过旋转鼠标滚轮在文档内滚动，使用“scroll up”和“scroll down”描述这种行为是可以的。

以下是部分词汇使用规范的总结表格：
| 词汇 | 使用规范 | 示例 |
| — | — | — |
| quick key | 不使用，用keyboard shortcut | |
| quit | 不同场景用不同替代词 | 用户关闭程序用exit |
| radio button | 特定情况下使用特定表述 | option button (also known as a radio button) |
| read/write | 代替read - write | read/write permission |
| reboot | 用restart代替 | After Setup is complete, restart your computer. |
| recommend | 避免特定表述 | 避免Microsoft recommends |
| registry | 大小写及结构规范 | 除Registry Editor外小写 |
| right | 避免单独作方向术语 | upper - right corner |

mermaid流程图展示部分操作流程：

graph TD;
    A[用户操作] --> B{是否涉及特定词汇};
    B -- 是 --> C{根据词汇规范选择表述};
    C --> D[正确表述输出];
    B -- 否 --> E[正常表述];

二、进一步的使用细节与注意事项

2.1 词汇使用的具体场景分析

2.1.1 不同受众的内容差异

在为普通受众和技术受众创作内容时，词汇的使用有明显区别。例如“range selection”，对于普通受众，使用“a range of cells”或“a range of dates”这样通俗易懂的表述；而对于技术受众，描述该功能时用“adjacent selection”，这样更专业和准确。再如“run”和“execute”，面向普通受众的内容尽量使用“run”，而在面向技术受众的内容中，“execute”在被动语态等情况下可以使用，但“run”在不损失含义时更受青睐。

2.1.2 界面与代码中的词汇处理

当用户界面或应用程序编程接口使用了特定词汇时，处理方式有所不同。如“reboot”，若在界面或接口的标签或元素名称中出现，可原样复制，但描述动作或事件时用“restart”。对于“radio button”，在软件开发内容中若应用程序编程接口包含该术语，可按特定方式表述，但在其他内容中需用替代方式指代。

2.2 易混淆词汇的区分

2.2.1 rights与permissions

“rights”以非特定方式指代系统管理员授权的系统操作，具体指代时用“user rights”；“permissions”适用于特定系统资源，如文件或打印机。例如，“Domain administrators should use a primary user account, which has basic user rights in the domain.”，这里强调的是用户在系统操作方面的权利；而对于文件的读写权限，则使用“permissions”，如“Users need read/write permissions to access this file.”。

2.2.2 sample与preview

“sample”是某物可能在屏幕上显示的图形表示，并非精确表示；“preview”是用户在屏幕上确切看到内容的图形表示。例如在设置控件样式时，“This displays a sample of what the control will look like with the scheme applied. To preview what the control will look like with the scheme applied, click Preview.”，先看到的是大致样子的“sample”，点击“Preview”可看到确切的显示效果。

2.3 特殊情况的处理

2.3.1 缩写词的使用

对于缩写词，如“RAM”“ROM”“RTFM”等，有明确的使用规范。“RAM”和“ROM”分别是“random access memory”和“read - only memory”的缩写，使用时可直接用缩写，但关于内存的表述指导需参考“memory”；“RTFM”由于可能被解读为使用粗口，不要使用。

2.3.2 前缀“re -”的特殊情况

以“re -”开头的单词，一般不加连字符，但为避免混淆或后接专有名词时需加。如“reenter”“recover”等正常使用，而“re - cover”（再次覆盖）、“re - create”（重新创造）为避免与“recover”“recreate”混淆而加连字符。不确定时可查阅《美国传统词典》或参考项目样式表。

2.4 操作相关词汇的使用规范

2.4.1 save的使用

“save”只能用作动词，不能用作名词。使用时搭配特定介词，如“save on a disk”“save to a file”“save for a rainy day”。例如“Before you turn off your computer, save your files.”，不能写成“Before you turn off your computer, do a save of your files.”。

2.4.2 scroll的操作表述

“scroll”不直接接宾语，使用方向信号词或介词。若滚动概念已明确，可用“move through”等动词短语。如“You can scroll through the document to get to the end.”，而不是“You can scroll the document to get to the end.”。

以下是更多词汇使用注意事项的表格总结：
| 词汇类别 | 注意事项 | 示例 |
| — | — | — |
| 缩写词 | 明确含义及使用规范 | RAM是random access memory的缩写 |
| 易混淆词 | 区分不同含义 | rights和permissions含义不同 |
| 操作词汇 | 遵循特定使用规则 | save只能作动词 |

mermaid流程图展示词汇使用的检查流程：

graph TD;
    A[撰写内容] --> B{检查是否有特定词汇};
    B -- 是 --> C{是否符合规范};
    C -- 是 --> D[内容完成];
    C -- 否 --> E[调整表述];
    E --> B;
    B -- 否 --> D;

通过遵循这些词汇使用规范，可以使技术写作更加准确、清晰和专业，避免因词汇使用不当而造成的误解。在实际写作过程中，要根据具体的受众、场景和需求，灵活运用这些规则，确保内容的质量和可读性。

三、词汇使用规范在实际写作中的应用案例

3.1 文档撰写中的词汇运用

3.1.1 软件操作指南文档

在撰写软件操作指南文档时，需要根据用户的操作场景准确使用词汇。例如，当描述用户关闭软件的操作时，应使用“exit”而不是“quit”。假设我们要编写一个文字处理软件的操作指南，其中关于关闭软件的步骤可以这样写：“当您完成文档编辑后，若要关闭软件，请点击软件界面右上角的‘exit’按钮。”

对于文档或窗口的关闭操作，使用“close”。如“如果您想关闭当前正在编辑的文档，可点击文档窗口右上角的‘close’按钮。”

在涉及到保存文档操作时，“save”只能用作动词，且要搭配合适的介词。比如“在编辑过程中，为避免数据丢失，建议您定期将文档‘save to a file’。”

3.1.2 系统配置说明文档

在系统配置说明文档中，对于一些专业术语的使用要严格遵循规范。以注册表相关内容为例，在描述注册表结构时，要准确使用“subtree”“key”“subkey”等术语。例如：“在注册表中，第一级的路径称为‘subtree’，如‘HKEY_CLASSES_ROOT’‘HKEY_LOCAL_MACHINE’；下一级为‘key’，如‘SOFTWARE’；‘key’以下的级别为‘subkey’，像‘\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Jet\3.5\Engines\Xbase subkey’。”

在描述系统重启操作时，使用“restart”。如“完成系统配置更改后，请‘restart’计算机以使设置生效。”

3.2 代码注释中的词汇规范

3.2.1 通用代码注释

在编写代码注释时，要使用准确、规范的词汇来解释代码的功能和逻辑。对于注释的表述，使用“comment”而不是“REM statement”。例如在Python代码中：

# 这是一个计算两个数之和的函数
def add_numbers(a, b):
    return a + b

这里的注释就是一个“comment”，清晰地说明了函数的功能。

3.2.2 特定编程语言中的注释

在不同的编程语言中，对于一些特定概念的注释也有相应的词汇规范。例如在Visual Basic中，虽然“REM statement”是注释的术语，但在通用的代码注释中，还是使用“comment”更合适。

3.3 技术报告中的词汇准确性

3.3.1 性能报告

在撰写技术性能报告时，对于数据的描述和操作的表述要准确。例如在描述屏幕分辨率时，使用“number × number”的格式。如“本次测试中，设备的屏幕分辨率为‘1920 × 1080’。”

对于系统权限相关的描述，要区分“rights”和“permissions”。如“用户在该系统中拥有基本的‘user rights’，但对于某些特定文件，需要相应的‘permissions’才能进行访问。”

3.3.2 功能介绍报告

在功能介绍报告中，对于产品功能的描述要使用规范的词汇。例如在介绍软件的某个控件时，对于“radio button”的描述，若面向普通用户，可根据其标签来指代；若面向开发人员，可使用“ option button (also known as a radio button)”。如“在该软件的设置界面中，有一个‘选择语言’的选项，您可以通过点击相应的选项来进行选择，这里的选项按钮类似于‘radio button’。”

以下是不同文档类型中部分词汇使用的总结表格：
| 文档类型 | 相关词汇 | 使用规范及示例 |
| — | — | — |
| 软件操作指南文档 | exit, close, save | 关闭软件用exit，关闭文档用close，save作动词搭配介词，如save to a file |
| 系统配置说明文档 | restart, subtree, key, subkey | 系统重启用restart，准确描述注册表结构用subtree、key、subkey |
| 代码注释 | comment | 通用注释用comment |
| 技术报告 | number × number, user rights, permissions | 屏幕分辨率用number × number，区分user rights和permissions |

mermaid流程图展示文档撰写中词汇使用的流程：

graph TD;
    A[确定文档类型] --> B{是否涉及特定词汇};
    B -- 是 --> C{根据文档类型和词汇规范选择表述};
    C --> D[撰写文档内容];
    B -- 否 --> D;
    D --> E{检查词汇使用是否正确};
    E -- 是 --> F[文档完成];
    E -- 否 --> G[调整表述];
    G --> D;

四、总结与建议

4.1 词汇使用规范的重要性总结

遵循词汇使用规范对于技术写作至关重要。准确、规范的词汇使用可以避免读者产生误解，提高文档的可读性和专业性。在不同的受众群体和写作场景中，合适的词汇选择能够确保信息的有效传达。例如，在面向普通用户的文档中使用通俗易懂的词汇，能让用户更容易理解操作步骤；而在面向技术人员的文档中，使用专业准确的术语则能体现内容的专业性和严谨性。

4.2 实际写作中的建议

4.2.1 建立词汇库

可以建立一个适合自己写作需求的词汇库，将常用的词汇及其使用规范整理在其中。在写作过程中，随时查阅词汇库，确保词汇使用的准确性。例如，将“quick key”“quit”“radio button”等词汇的使用规范记录下来，方便写作时参考。

4.2.2 进行同行评审

在完成文档初稿后，邀请同行进行评审。同行可以从不同的角度发现词汇使用中存在的问题，提出宝贵的建议。例如，其他技术作者可能会指出某些词汇在特定语境下的使用是否合适，或者是否有更合适的替代词汇。

4.2.3 持续学习和更新

技术领域不断发展，新的词汇和概念不断涌现，词汇的使用规范也可能会发生变化。因此，要持续学习和关注词汇使用的最新动态，及时更新自己的知识。可以通过阅读专业的技术写作书籍、参加相关的培训课程等方式来提升自己的词汇使用能力。

以下是遵循词汇使用规范的好处及写作建议的表格总结：
| 方面 | 内容 |
| — | — |
| 重要性 | 避免误解，提高可读性和专业性，确保信息有效传达 |
| 建议 | 建立词汇库，进行同行评审，持续学习和更新 |

mermaid流程图展示遵循词汇使用规范的写作流程：

graph TD;
    A[开始写作] --> B[查阅词汇库];
    B --> C[撰写内容];
    C --> D[同行评审];
    D -- 有问题 --> E[调整词汇使用];
    E --> C;
    D -- 无问题 --> F[完成写作];
    F --> G[持续学习更新词汇知识];
    G --> B;

通过严格遵循词汇使用规范，并结合实际写作中的建议，我们能够提高技术写作的质量，为读者提供更准确、清晰、专业的技术文档。在未来的技术写作中，我们应不断强化对词汇使用规范的认识和应用，以适应不断发展的技术领域的需求。