37、技术写作术语规范与使用指南

技术写作术语规范与使用指南

1. 设备相关术语

1.1 平板电脑（tablet, tablet PC）

在描述设备时，一般使用最通用的术语。如无特殊需求以区分不同类型设备，通常使用“computer”或“PC”。“tablet”是一种便携式计算机，用户可通过手写笔或触摸手势与屏幕交互，它可能带有也可能不带有集成键盘。提及运行 Windows 系统的平板电脑时，可使用“tablet PC”，但不要写成“tablet portable computer”。若需描述带有集成键盘且显示屏可像笔记本电脑或平板电脑那样使用的便携式计算机，可使用“convertible tablet”。

1.2 台湾（Taiwan）

只能用“Taiwan”来称呼台湾，绝不能使用“Republic of China”或“ROC”。若需缩写，ISO 规定的缩写是“TWN”。

1.3 点击（tap）

在编写与触摸屏幕或使用手写笔相关的内容时，使用“tap”和“double - tap”代替“click”和“double - click”。“tap”指用手指或笔尖轻按屏幕后迅速抬起。若程序要求特定交互，使用“tap and hold”，而不要用“press and hold”或“touch and hold”。例如：
- Tap the Internet Explorer icon.
- Tap Internet Explorer.
- Tap and hold the album that you want to remove, and then tap Delete.

1.4 目标磁盘、驱动器、文件（target disk, target drive, target file）

避免使用这些术语，因为它们含义模糊且难以翻译。若必须表达“目标”的概念，可使用“destination disk”“destination drive”或“destination file”，但最好明确指出所讨论的磁盘、驱动器或文件。

1.5 任务栏（taskbar）

“taskbar”为一个单词。

2. 存储与网络相关术语

2.1 太字节（terabyte）

1 太字节等于 1,099,511,627,776 字节，或 1,024 吉字节。不要缩写，数字与“terabyte”之间要留空格；若用作形容词，需加连字符。例如：
- 36 terabytes
- 36 - terabyte database
当用作名词表示测量时，需加“of”构成介词短语，如“This database contains 36 terabytes of information.”。

2.2 Telnet

小写的“telnet”指实现 Telnet 终端仿真协议的客户端程序，也可用于表示使用该协议；大写的“Telnet”指协议本身，在 UNIX 系统中，该协议通常全大写（TELNET）。

2.3 通用命名约定（UNC）

“UNC”是“Universal Naming Convention”的缩写，用于表示服务器和计算机的名称，如“\Servername\Sharename”。首次提及应拼写完整，除非确定受众熟悉该缩写，且仅用于面向技术受众的内容。

3. 语法与用词规范

3.1 “that”与“which”

“that”引导限制性从句，该从句对句子表意至关重要，且与先行词之间不用逗号分隔；“which”引导非限制性从句，该从句可省略而不影响句子意思，且前面需用逗号。例如：
- 正确：You will need to supply information about applications that you want to run with Windows.
- 错误：You will need to supply information about applications which you want to run with Windows.
- 正确：Your package contains the subsidiary information card, which you can use to obtain device drivers or local technical support.

在国际使用场景中，即使句子没有“that”也表意清晰，最好还是在限制性从句中使用“that”，以避免歧义，方便非英语母语者和机器翻译理解。另外，不要用“that”或“which”指代人，而要用“who”。

3.2 “then”的使用

“then”不是并列连词，不能正确连接两个独立的从句。可使用“and then”或“then”加分号来连接，也可另起一句以“Then”开头，或在步骤说明中把“then”引导的从句作为单独一步，不使用“then”。例如：
- 正确：On the File menu, click Save As, and then type the name of the file.
- 正确：On the File menu, click Save As; then type the name of the file.
- 正确：On the File menu, click Save As. Then type the name of the file in the Save as box.
- 错误：On the File menu, click Save As, then type the name of the file.
同时，避免在“if”从句后的从句开头使用“then”（即“if…then”结构）。

3.3 “titled”与“entitled”

为保持一致性，描述书籍等事物的标题时，用“titled”；“entitled”表示“有权享有”。若“the book titled”这类短语并非必要，可不使用。若使用“titled”，其后不用逗号。例如：
- Look in the book titled User’s Guide, which accompanies your software.
- Look in the User’s Guide that accompanies your software.

3.4 “toggle”的使用

“toggle”用作形容词，如“toggle key”，它能开启或关闭特定模式。不要将其用作动词，描述操作时使用“switch”“click”或“turn on”“turn off”。例如：
- 正确：Use the Caps Lock key to switch from typing in capital letters to typing in lowercase letters.
- 正确：To turn the Ruler on or off, click Ruler on the Edit menu.
- 错误：Toggle the Caps Lock key on or off to switch from capital letters to lowercase letters.
- 错误：To turn the Ruler on or off, toggle Ruler on the Edit menu.

3.5 “type”与“enter”

对于用户必须输入的信息，如密码，使用“type”代替“type in”或“enter”；对于用户既可以输入也可以从列表中选择的信息，可使用“type”或“enter”，也可使用“type or select”。例如：
- Type your password.
- Enter the file name.
- Type the path to the server or select it from the list.

4. 界面与操作相关术语

4.1 文本框（text box）

一般通过其标签来称呼用户输入文本的框。若需使用描述词，用“box”，除了在数据库程序相关内容中，不要使用“field”或“entry field”。在面向软件开发人员的内容中，设计和开发用户界面时可使用“text box”。

4.2 标题栏（title bar）

指窗口顶部显示文档或程序名称的水平条，可用于面向所有受众的内容。

4.3 工具（tool）

用“tool”代替“utility”来描述有助于完成一项或一组任务的功能。

4.4 工具箱（toolbox）

通常是绘图或界面工具的集合，如画笔、线条、圆形、剪刀和喷雾罐等。在编程应用（如 Visual Basic）中，还包括用户可添加到程序中的控件，如命令按钮和选项按钮。工具箱中的工具与工具栏上的命令不同，这些形状或控件通常可拖到文档中并进行操作。处理工具箱中的元素时，像处理对话框中的其他选项一样，使用粗体格式显示工具箱标签，并在步骤说明中告知用户点击特定选项。除非与界面一致或为特定命名的产品功能，否则不要大写“toolbox”。例如：Insert a Combo Box control in the dialog box.

4.5 提示框（tooltip）

“tooltip”为一个单词。

4.6 左上角、右上角（top left, top right）

用作形容词时需加连字符，且不要用它们来表示“upper left”和“upper right”。应使用“upper left”和“upper right”，用作形容词时也需加连字符。

以下是一些术语使用规范的总结表格：
|术语|正确用法|错误用法|
| ---- | ---- | ---- |
|tablet PC|可用于指运行 Windows 的平板电脑|tablet portable computer|
|Taiwan|Taiwan|Republic of China, ROC|
|tap|tap, double - tap, tap and hold|click, double - click, press and hold|
|target disk 等|destination disk 等|target disk, target drive, target file|
|terabyte|36 terabytes, 36 - terabyte database|TB|
|that vs which|用 that 引导限制性从句，which 引导非限制性从句|混淆使用|
|then|and then, then 加分号等|直接连接独立从句|
|titled vs entitled|titled 指标题，entitled 指有权享有|entitled 用于指标题|
|toggle|作形容词，如 toggle key|作动词|
|type vs enter|type 用于必须输入的信息|type in|

下面是一个关于操作步骤中“then”使用规范的 mermaid 流程图：

graph LR
    A[On the File menu, click Save As] --> B{选择连接方式}
    B -->|and then| C[Type the name of the file]
    B -->|then 加 ;| D[Type the name of the file]
    B -->|另起一句| E[Then type the name of the file in the Save as box]

5. 其他相关术语

5.1 三维与二维相关

• 三维（three - dimensional, 3 - D） ：首次提及需拼写完整，后续使用中“three - dimensional”更优，但“3 - D”也可使用。当空间有限或遵循用户界面时，用“3 - D”。拼写和缩写形式都要加连字符，仅在产品名称有规定时使用“3D”（无连字符）。
• 二维（two - dimensional, 2 - D） ：同样首次提及拼写完整，后续“two - dimensional”优先，“2 - D”也可行。在空间受限或遵循界面时用“2 - D”，拼写和缩写都加连字符，仅按产品名称规定使用“2D”（无连字符）。

5.2 时间相关

• 时间炸弹（time bomb, timebomb） ：不要使用，用“expiration date”代替。
• 时间戳（time stamp） ：为两个单词。
• 超时（time - out, time out） ：作形容词或名词时要加连字符，作动词短语时不加。例如：
  • A time - out occurs if the connection can’t be made.
  • If the connection isn’t made, a time - out event occurs.
  • The connection timed out.

5.3 帮助相关

使用“Help topic”代替“Help entry”或“Help article”。

5.4 方向相关

• toward ：使用“toward”代替“towards”。
• upward ：用“upward”代替“upwards”。

5.5 恶意软件相关

“trojan horse”或“trojan”指看似有用或无害，但包含用于利用或破坏运行系统的隐藏代码的程序，也叫“trojan code”。面向技术受众时，可简称为“trojan”。例如：A trojan horse is a type of malicious software.

5.6 布尔值相关

一般在面向软件开发人员的内容中，用全大写的“TRUE”表示返回值。若针对特定编程语言，遵循该语言的大小写规则。

5.7 旋转操作相关

使用“turn”来描述在用户界面上用手指或手旋转物体的触摸手势或空中手势，就像转动旋钮一样。例如：
- Touch the Volume knob on the screen with your thumb and at least one finger, and then turn it clockwise or counterclockwise.
- Hover over the knob, and then turn it clockwise or counterclockwise.

5.8 开关操作相关

• 开关机 ：用“turn on”“turn off”代替“power on”“power off”；“start”“stop”；“switch on”“switch off”来表示计算机的开关机。
• 程序功能 ：用“turn on”“turn off”代替“enable”“disable”来指命令或其他程序功能。但在程序步骤中，不要用“turn on”“turn off”来指选择或清除复选框，要用“select”和“clear”或“click to select”和“click to clear”。不过在网页上，如多媒体状态选项，可用“turn on”“turn off”，例如 “You can turn off graphics.”

5.9 其他杂项

• turnkey ：为一个单词。
• tutorial ：使用“tutorial”代替“CBT”。

6. 特殊操作与术语避免

6.1 复选框与选择

不要使用“uncheck”“unmark”“unselect”来处理复选框或选择，用“clear the check box”或“cancel the selection”代替。

6.2 删除恢复操作

除了遵循用户界面或应用程序编程接口，不要使用“undelete”，用“restore”代替。即便产品界面使用“undelete”，实际操作也是“restore”。例如：To restore the deleted text, click Undelete on the Edit menu.

6.3 文本格式与字符

• underline ：用于指文本格式化为下划线字符或格式化。
• underscore ：用于指下划线字符（_）。

6.4 撤销操作

不要将命令名“Undo”用作名词来指撤销操作，尤其在复数形式中。可以换种表达方式，如“to undo multiple actions”或“select the actions that you want to undo”。不过可以说某个命令撤销了一个操作。

6.5 安装与卸载

• 安装 ：一般用“uninstall”指从计算机系统中移除硬件或软件。但如果上下文是关于添加（而非安装）软件或硬件，首选术语是“remove”。
• 名词使用 ：不要将“uninstall”用作名词。

6.6 不可打印字符

不要使用“unprintable”，用“nonprinting”代替。

6.7 注册相关

“unregister”可用于面向软件开发人员的内容。

6.8 恶意软件统称

使用“unwanted software”作为间谍软件、广告软件和类似软件的通用术语，不要使用“deceptive software”。

6.9 更新相关

• 名词 ：“update”作为名词，指针对非关键、非安全相关的特定问题的广泛发布的修复程序；“critical update”指针对关键、非安全相关的错误的修复程序。
• 动词 ：“update”作为动词，指安装软件更新或服务包的操作，也可代替“refresh”来描述屏幕上图像恢复或表格中数据更新的操作。

6.10 升级相关

“upgrade”指用产品的新版本替换已安装版本的软件包，升级过程通常保留现有客户数据和偏好。不要将“upgrade”用作“update”“service pack”或产品版本之间其他发布的同义词。例如：
- To upgrade your operating system to Windows 7, place the CD in the drive.
- To install the upgrade version, you must already have a previous version of the program on your computer.
- The upgrade was successful.

6.11 UPnP 相关

• 首次提及 ：首次提及“UPnP”时应拼写完整，除非确定受众熟悉该缩写，且仅用于面向技术受众的内容。
• 使用规范 ：使用时要遵循相关商标规定，首次提及加商标符号，在商标列表中注明 “UPnP™ is a certification mark of the UPnP™ Implementers Corporation.”。作为形容词，后面接“certified”和特定术语，如“device”“architecture”“standards”等，不要用“UPnP”指未认证的设备，也不要单独用作名词，不在产品名称和设备商标中使用。

6.12 大小写相关

• uppercase ：作为形容词和名词时为一个单词，不要用“uppercased”，也不要用作动词。当“lowercase”和“uppercase”一起使用时，不要用连字符省略形式。例如：
  • You can quickly change the capitalization of all uppercase and lowercase letters.
  • Change all the lowercase letters to uppercase.
• uppercase and lowercase ：作为复合形容词时，不要用连字符省略形式，用“uppercase and lowercase”，而不是“upper - and lowercase”。

6.13 扩展相关

一般用“scale up”代替“upsize”，尽管“upsize”在客户端/服务器产品中已成为常用行话。

以下是更多术语使用规范的表格总结：
|术语|正确用法|错误用法|
| ---- | ---- | ---- |
|three - dimensional, 3 - D|首次拼写完整，后续可 3 - D|不按规则缩写|
|two - dimensional, 2 - D|首次拼写完整，后续可 2 - D|不按规则缩写|
|time bomb|expiration date|time bomb, timebomb|
|time stamp|time stamp|无|
|time - out|作形/名词加连字符，作动词短语不加|不按规则使用连字符|
|Help topic|Help topic|Help entry, Help article|
|toward|toward|towards|
|upward|upward|upwards|
|trojan horse|trojan horse, trojan|无|
|TRUE|全大写（一般情况）|不按语言规则大小写|
|turn|描述旋转操作|无|
|turn on/off|开关机、程序功能开关|power on/off 等|
|uncheck 等|clear the check box 等|uncheck, unmark, unselect|
|undelete|restore|除遵循界面外使用 undelete|
|underline/underscore|underline 指格式，underscore 指字符|混淆使用|
|Undo|换表达，如 undo multiple actions|将 Undo 作名词|
|uninstall|remove（添加相关），非名词|作名词，不按上下文使用|
|unprintable|nonprinting|unprintable|
|unwanted software|unwanted software|deceptive software|
|update|名词指修复，动词指安装更新等|无|
|upgrade|用新版本替换旧版本|与 update 等混用|
|UPnP|按商标规则使用|违规使用|
|uppercase|一个单词，不做动词|uppercased, 作动词|
|uppercase and lowercase|不用连字符省略|upper - and lowercase|
|upsize|scale up|upsize|

下面是一个关于软件操作术语使用规范的 mermaid 流程图：

graph LR
    A[操作场景] --> B{是否为安装/卸载}
    B -->|是| C{上下文是添加吗}
    C -->|是| D[使用 remove]
    C -->|否| E[使用 uninstall]
    B -->|否| F{是否为开关操作}
    F -->|是| G{是否为复选框选择}
    G -->|是| H[使用 select/clear]
    G -->|否| I[使用 turn on/off]
    F -->|否| J{是否为撤销操作}
    J -->|是| K[换表达，避免 Undo 作名词]
    J -->|否| L[按对应规范使用其他术语]

总之，在各类技术写作和操作描述中，准确使用术语至关重要。遵循这些规范能确保内容清晰、准确且易于理解，无论是面向普通用户还是技术专业人员，都能提供更好的沟通效果。