39、技术文档中的术语使用与规范

最新推荐文章于 2025-11-16 03:04:21 发布

vim8coder

最新推荐文章于 2025-11-16 03:04:21 发布

阅读量158

点赞数

CC 4.0 BY-SA版权

分类专栏：解读《微软风格指南》：专业交流的艺术文章标签：技术文档术语规范术语使用

本文链接：https://blog.youkuaiyun.com/vim8coder/article/details/150141341

解读《微软风格指南》：专业交流的艺术专栏收录该内容

39 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

技术文档中的术语使用与规范

一、术语使用基础规则

1.1 特定词汇的正确用法

在技术文档的撰写中，许多词汇有着特定的使用规范。例如，“website” 是比 “Web site” 更常用的表述，除非必须遵循用户界面的要求。“weblication” 作为 “web application” 的行话，容易与 “web publication” 混淆，应避免使用。“where” 可用于在代码或公式中引入列表，以定义变量或符号等元素的含义，如 “Use the following formula to calculate the return, where: r = rate of interest; n = number of months; p = principal”。

1.2 词汇使用的时间与语义区分

“while” 仅用于指在时间上发生的事情，不能作为 “although” 或 “whereas” 的同义词。例如 “Fill out your registration card while you wait for Setup to be completed” 是正确的用法。“whitelist” 应避免使用，可参考 “blacklist”。“white paper” 为两个单词，“white space” 作名词时为两个单词，作形容词时为连字符形式 “white - space”。

1.3 人称指代的选择

在指代人时，虽然 “that” 用于指人并无语言学上的错误，但使用 “who” 更为礼貌。例如 “Custom Setup is for experienced users who want to alter the standard Windows configuration” 比 “Custom Setup is for experienced users that want to alter the standard Windows configuration” 更合适。

二、技术相关术语规范

2.1 网络与通信术语

“Wi - Fi” 是正确的写法，在提及特定的 Wi - Fi 技术时要大写并使用连字符，可能的话，使用 “wireless network” 等通用短语更好。“wildcard character” 指可用于代表一个或多个字符的键盘字符，如 “*” 或 “?”，“wildcard” 为一个单词。

2.2 操作系统相关术语

对于操作系统相关的术语，有诸多严格的规范。“Microsoft Windows AntiSpyware” 要注意大小写，其简称是 “Windows AntiSpyware”。“Windows 7” 要使用完整名称，且不要在前面加 “Microsoft”。“Windows Events” 是涵盖各种 Windows 版本中发生的事件的通用术语。“Windows Explorer” 不能作为 “Internet Explorer” 的同义词，它是 Windows 操作系统中显示计算机上文件和文件夹层次结构的功能，不要加 “the” 且不要缩写为 “Explorer”。

2.3 编程与开发术语

“Winsock” 可用于指代 Windows Sockets API，除非别无选择，否则不要使用 “Sockets”。“wireframe” 为一个单词，指一种三维图形。“want” 应代替 “wish” 或 “desire”，且不要与 “need” 混淆，“need” 表示要求或义务，“want” 表示用户有行动的选择权，如 “If you want to use a laser printer, you need a laser printer driver”。

三、文档格式与排版规范

3.1 通用格式规范

在文档格式方面，有许多细节需要注意。例如，缩写和首字母缩写词的使用有特定规则，包括采用新的缩写、冠词的使用、大小写、索引、国际考虑因素、测量单位的缩写等。在测量单位方面，有详细的缩写表格可供参考，且要注意缩写的一致性和准确性。

3.2 标题与索引规范

标题的大小写有明确的指南，要保持一致使用，遵循用户界面的要求。索引条目也有相应的大小写和排序规则，如按 ASCII 排序等。在跨引用时，要注意格式和一致性，确保读者能够准确找到相关内容。

3.3 表格与列表规范

表格和列表在文档中也有重要的作用。表格的引入、格式、国际考虑因素等都有规范，要确保表格的清晰和易读性。列表分为项目符号列表和编号列表，项目符号列表在程序中可用于突出关键信息，编号列表常用于程序步骤的描述，要注意列表的标点和格式。

以下是一些常见术语的使用规范对比表格：
|术语|正确用法|错误用法|
| ---- | ---- | ---- |
|website|Use website|Use Web site|
|weblication|Avoid using|Use as jargon for “web application”|
|while|Refer to time - related events|Use as synonym for although or whereas|
|who|Refer to users|Use that to refer to users|
|Wi - Fi|Use Wi - Fi|Use WiFi, wifi, or Wifi|

下面是一个简单的 mermaid 流程图，展示编写技术文档时检查术语使用的流程：

graph TD;
    A[开始编写文档] --> B[选择术语];
    B --> C{是否有特定规范};
    C -- 是 --> D[遵循规范使用];
    C -- 否 --> E{是否易混淆};
    E -- 是 --> F[避免使用];
    E -- 否 --> G[正常使用];
    D --> H[完成文档编写];
    F --> B;
    G --> H;

四、其他重要术语及规范

4.1 硬件与设备术语

在描述硬件和设备时，有许多术语需要准确使用。“disk” 和 “disc” 在不同情境下有不同的用法，“disk” 更常用于指硬盘等存储设备，“disc” 常用于指光盘等可移动存储介质。“device” 指代设备，“device driver” 则是设备驱动程序，要准确区分和使用。“monitor” 指显示器，“mouse” 指鼠标，对于这些常见设备的术语，要确保在文档中一致使用。

4.2 网络与互联网术语

网络和互联网相关的术语也有严格规范。“Internet” 特指互联网，“intranet” 指企业内部网，“extranet” 则是企业外部网。“IP address” 是互联网协议地址，“URL” 是统一资源定位符，在提及这些术语时，要注意大小写和格式。例如，“URL” 中的字母要大写，且在文档中引用时要遵循统一的格式。

4.3 软件与编程术语

软件和编程领域的术语更是复杂多样。“application” 和 “program” 虽然都可指应用程序，但在特定语境下有不同的含义。“application” 更侧重于用户使用的应用，“program” 则更强调程序代码本身。“function” 是函数，“variable” 是变量，对于这些编程元素的术语，要准确理解和使用。在代码示例中，变量名、函数名等的命名也要遵循一定的规范，以提高代码的可读性和可维护性。

以下是一些硬件和网络术语的使用规范表格：
|术语|含义|正确用法示例|
| ---- | ---- | ---- |
|disk|硬盘等存储设备|The disk has a large capacity|
|disc|光盘等可移动存储介质|Insert the disc into the drive|
|Internet|互联网|Access the Internet for more information|
|intranet|企业内部网|The company’s intranet provides internal resources|

下面是一个 mermaid 流程图，展示在软件开发中选择合适术语的流程：

graph TD;
    A[开始软件开发] --> B[确定功能模块];
    B --> C{是否有标准术语};
    C -- 是 --> D[使用标准术语];
    C -- 否 --> E{是否可自定义术语};
    E -- 是 --> F[自定义术语并记录];
    E -- 否 --> G[寻求专业建议];
    D --> H[完成术语选择];
    F --> H;
    G --> H;