31、技术写作术语使用规范

技术写作术语使用规范

一、常见术语使用规范

1.1 时间相关

  • 午夜(midnight) :不要用 12 A.M. 或 12 P.M. 来表示午夜,建议使用 00:00 或者直接用 midnight。并且午夜被认为是新一天的开始,而非旧一天的结束。若担心产生歧义,可使用 23:59 或 00:01。

1.2 软件与系统相关

  • 微软反间谍软件(Microsoft Windows AntiSpyware) :注意大小写,这是微软反间谍软件产品的名称,简称是 Windows AntiSpyware。
  • MS - DOS :不能用 DOS 指代 MS - DOS 操作系统;也不能将 MS - DOS 用作非 MS - DOS 操作系统组件或方面的形容词,要用 MS - DOS - based。例如,应该说“MS - DOS - based program”“MS - DOS - based computer”“MS - DOS command” ,而不是“DOS program”“MS - DOS program”“MS - DOS computer” 。MS - DOS prompt 不能用来表示命令提示符。当讨论在 MS - DOS 操作系统上运行的软件时,使用 MS - DOS - based program 代替非 Windows 程序。对于技术受众的内容,可将仅在命令提示符窗口中运行的程序称为控制台应用程序;若受众熟悉字符型应用程序这个术语,也可用于泛指不在 Windows 或其他图形环境中运行的程序。

1.3 界面操作相关

  • 最小化(minimize) :可以作为动词使用。Minimize button 指未最小化窗口右上角包含短横线的按钮,它与窗口快捷菜单中的 Minimize 命令功能相同。不要使用 Minimize box 或 Minimize icon,要用“Minimize button”来指代该按钮,而不是仅用“Minimize” ,不过 minimize 作为动词使用是没问题的,Minimize button 中的 Minimize 始终用粗体。例如,“Click the Minimize button.”“To reduce a program to a button on the taskbar, minimize the window.” 。
  • 鼠标操作(mouse over) :不要将 mouse over 用作动词短语,描述鼠标移到按钮上的动作时,对于新手用户可以用“move the pointer over the button” ,一般可用“point to” 。

1.4 设备相关

  • 移动设备(mobile device) :一般使用描述特定设备最常见的术语,如 phone 或 tablet,仅在需要泛指一类设备并与非便携式设备区分时使用 mobile device。
  • 移动电话(mobile phone) :通常使用描述设备最通用的术语,如仅用 phone,除非需要强调手机的移动性时才用 mobile phone。若指特定类型的移动电话,如蜂窝电话或数字电话,可以具体说明。仅在需要区分智能手机和其他类型手机时使用 smartphone,不要使用 mobile telephone,除非要描述包含手机、笔记本电脑和平板电脑等设备的通用类别,否则不要用 device 指代手机。
  • 显示器(monitor) :指包含屏幕的视觉显示硬件,用 screen 指代显示器的图形部分,用 display 作为任何视觉输出设备的通用术语,如便携式计算机上的平板显示器。例如,“Turn on the monitor.”“Icons appear on the screen.”“The newest laptops have active - matrix LCD displays.”

1.5 符号与格式相关

  • 减号(minus sign) :除用户输入必须键入连字符的情况外,减号使用 en 破折号,这种情况下应明确指出正确的键。减号的 HTML 代码是 –。
  • 乘号(multiplication sign) :一般用乘号(×)表示数学运算,而不是字母 x,若需与用户界面匹配,可用星号(*)。在表示屏幕分辨率或物理尺寸时,用 × 表示“by” ,乘号的 HTML 代码是 × 或 ×。

1.6 其他术语

  • 多任务(multitasking) :不要将该词用作动词,它属于行话。例如,应该说“Windows 7 supports multitasking.” ,而不是“You can multitask with Windows 7.”
  • 多线程(multithreaded) :使用 multithreaded 代替 multithread。

二、术语使用的注意事项

2.1 前缀与连字符

  • multi - :一般情况下,以 multi 开头的单词不要加连字符,除非为避免混淆或 multi 后面接专有名词。不确定时,可查看《美国传统词典》或咨询项目样式表。若该词不在其中或以下列表中,可在该词前用 multiple,不要用 multi 组合创造新单词。例如,正确的有 multicast、multichannel、multicolumn、multilevel、multiline、multilingual、multimedia、multiprocessor、multipurpose、multitasking、multiuser 。
  • non - :以 non - 开头的单词,如 nonnumeric 和 nonzero,一般不加连字符,除非为避免混淆,如 non - native,或 non - 后面接专有名词,如 non - English。不确定时,查看《美国传统词典》或咨询项目样式表,不要用 non - 否定整个短语。例如,应该说“security - related”“unrelated to security” ,而不是“non - security related” 。

2.2 避免使用的术语

  • 移动键(movement keys) :不要使用,用箭头键(arrow keys)代替。
  • 不连续选择(disjoint selection、nonadjacent selection、noncontiguous selection) :在面向普通受众的内容中,不要用这些术语来描述表格或工作表中不相邻单元格等项目的选择类型。仅在面向技术受众且该术语出现在用户界面或应用程序编程接口中时使用,一般若必须描述不相邻的选择项,使用 multiple selection 或具体提及不相邻的项目。例如,“To select multiple adjacent cells, drag across the cells that you want to select.”“To select nonadjacent cells, select a single cell, and then hold down the Ctrl key while you click other cells that you want to select.”

2.3 易混淆术语区分

  • 需要(need)和想要(want) :要根据情况使用合适的术语,need 意味着要求或义务,want 表示用户有行动选择。例如,“If you want to use a laser printer, you need a laser printer driver.”

2.4 特定缩写与名称

  • MPEG :是 Moving Picture Experts Group 的缩写(不是 Motion Pictures Experts Group),这是一个负责制定动态图片(有无音频均可)文件格式等工作的组织。MPEG 格式的文件用于 CD - ROM、视频 CD 和 DVD,不要拼写全称,MPEG 文件的扩展名是 .mpg。
  • .NET :注意大小写,始终以点(.)开头,不要拼写为 dot NET。必要时可以用 .NET 开头写句子,但要注意连续的点可能会让一些用户短暂困惑。

2.5 网络相关

  • 网络(network) :不要缩写为 net,不要将 network 用作动词描述计算机连接到网络的动作。计算机在网络上用“on” ,而不是“in” ,网络上的计算机是“linked”或“connected” ,而不是“networked” 。仅在指建立个人和业务联系时,使用 network 作为动词和 networking 作为名词。
  • 网络适配器(network adapter) :用 network adapter 代替 network card 来描述支持计算机连接网络的硬件。
  • 网络管理员(network administrator) :仅在具体指网络管理员时使用,一般使用 administrator 或 system administrator,除非必须指定特定类型。
  • 网络连接(network connection) :使用 network connection 代替 local area network connection。
  • 网络驱动器(network drive) :使用 network drive 代替 remote drive。

三、其他杂项

3.1 数字表示

  • 小写斜体的 n 通常用于表示数字的通用用法,当数字的值是任意的或不重要时可以使用,如“move the insertion point n spaces to the right” ,而小写斜体的 x 用于表示数学方程中的未知数(变量)或其他占位符。但要注意,由于 n 在所有语言中并不都表示数字的通用用法,在机器翻译内容中使用 n 可能会导致误译。
  • 始终完整拼写 nanosecond,表示十亿分之一秒。

3.2 语言表达规范

  • of 的使用 :不要在“off of”或“outside of”等短语中使用 of,这是口语化表达,可能会让全球受众困惑。例如,应该说“The taskbar is outside the main window area.”“Save your work and then log off the network.” ,而不是“The taskbar is outside of the main window area.”“Save your work and then log off of the network.”
  • 离线(offline) :任何情况下都用一个单词,用于表示未连接到系统或网络,不要用于俚语意义上的“在当前上下文之外” 。
  • 本地与远程计算(off - premises、on - premises) :这两个术语用于区分本地计算(计算资源位于客户自己的设施中)和远程计算(计算资源部分或全部通过云计算提供),在所有位置都要加连字符,注意 premises 是复数,不要使用 on - premise、off - premise ,也不要使用 on - premises cloud 或 off - premises cloud。
  • 好的(okay、OK) :仅在与用户界面匹配时使用 OK,否则使用 okay。在过程中提及 OK 按钮时,不要使用“the and button” 。例如,“In the Save As dialog box, click OK.”“It is okay to write passwords down, but keep them secure.” 。如果在过程结束时很明显用户必须点击 OK 才能完成过程,可以省略“Click OK” 。
  • on 的使用 :on 与以下元素搭配使用:
    • 菜单:“the Open command is on the File menu”
    • 任务栏、工具栏、标尺和桌面:“click Start on the taskbar”
    • 磁盘,指程序在磁盘上:“the printer drivers on Disk 2”

3.3 名称使用规范

  • Net :注意大小写,是 Internet 的俚语表达,可在非正式写作中使用,不要在产品文档中使用。
  • netbook 和 notebook :除非指名称中包含 netbook 或 notebook 的特定计算机型号,否则使用 computer 或 laptop 代替。
  • 通知区域(notification area) :任务栏右侧的区域,以前称为系统托盘(system tray)或状态区域(status area),时钟和系统通知显示在此处。不要使用 system tray、systray、status area 作为 notification area 的同义词,可以提及通知区域的位置,但不要将这些描述融入名称,名称始终是 notification area,不要单独用 area 指代通知区域,避免名词堆叠和可能让人觉得有多个通知区域的描述。例如,“The clock appears in the notification area, at the far right of the taskbar.”“The notification area is located at the far right of the taskbar.”

3.4 字符与符号

  • NUL、null、NULL、Null :要区分空字符(ASCII NUL)和零字符,空字符不显示任何内容,但占用空间,用 ASCII 代码 0 表示;零字符指数字 0,用 ASCII 代码 48 表示。用小写 null 表示空值,更好的做法是用 null value 避免与常量混淆,根据语言使用 NULL 或 Null 仅指代常量。
  • null - terminated 和 null - terminating :使用 null - terminated 作为形容词,如“null - terminated string” ,不要使用 null - terminating,如“null - terminating character” ,要用“terminating null character” 。
  • # 符号 :用 number sign 代替 pound sign 来指代 # 符号,但可以用 pound key (#) (包括括号中的符号)专门指电话或电话号码。始终完整拼写 number,不要使用 # 符号,除非作为键名,如用 number 7 而不是 #7。在表格等空间有限的情况下,可以将 number 缩写为 No,但要注意,由于 No. 在其他语言中不用于缩写 number,在机器翻译内容中使用可能会导致误译。
  • numeric :使用 numeric 代替 numerical,对于小键盘,使用 numeric keypad 代替 numerical keypad 或 numeric keyboard。

以下是一个简单的 mermaid 流程图,展示了选择移动设备术语的流程:

graph TD;
    A[描述特定设备] --> B{是否需泛指并区分非便携设备};
    B -- 是 --> C[使用 mobile device];
    B -- 否 --> D{设备类型};
    D -- 手机 --> E[是否强调移动性];
    E -- 是 --> F[使用 mobile phone];
    E -- 否 --> G[使用 phone];
    D -- 平板 --> H[使用 tablet];

通过遵循这些术语使用规范,可以使技术写作更加准确、清晰,避免产生歧义,提高文档的质量和可读性。在实际写作过程中,要时刻牢记这些规则,确保所使用的术语符合规范要求。

四、特定情境下的术语使用总结

4.1 操作系统相关术语总结

术语 使用规范 示例
MS - DOS 不能用 DOS 指代;非组件或方面不用作形容词,用 MS - DOS - based;MS - DOS prompt 不表示命令提示符;讨论运行软件用 MS - DOS - based program MS - DOS - based program、MS - DOS command
Windows NT 不要用 NT 代替 Windows NT

4.2 界面与操作术语总结

术语 使用规范 示例
Minimize 可作动词;指代按钮用 Minimize button Click the Minimize button;minimize the window
mouse over 不用作动词短语,用 point to 或 move the pointer over point to the button
movement keys 不用,用 arrow keys 代替 arrow keys

4.3 设备与网络术语总结

术语 使用规范 示例
mobile device 一般用具体术语,需泛指且区分非便携时使用 mobile device
mobile phone 一般用 phone,强调移动性用 mobile phone mobile phone
network 不缩写,不用于描述连接动作;计算机用 on;仅用于建立联系时作动词和名词 on the network;networking
network adapter 代替 network card network adapter

五、关键术语操作步骤示例

5.1 选择合适的移动设备术语操作步骤

  1. 确定是否在描述特定设备。
  2. 如果是,判断是否需要泛指该类设备并与非便携式设备区分:
    • 若需要,使用 mobile device。
    • 若不需要,判断设备类型:
      • 若为手机,判断是否需要强调移动性:
        • 若需要,使用 mobile phone。
        • 若不需要,使用 phone。
      • 若为平板,使用 tablet。

5.2 选择合适的多任务术语操作步骤

  1. 确定是否在描述操作系统支持多任务的能力:
    • 若是,使用“系统名称 + supports multitasking”的句式,如“Windows 7 supports multitasking”。
    • 若不是描述支持能力,避免使用 multitasking 作动词。

5.3 选择合适的网络相关术语操作步骤

  1. 对于网络连接相关:
    • 描述计算机连接网络的硬件,使用 network adapter。
    • 描述计算机与网络的关系,使用 on the network。
    • 描述网络连接,使用 network connection。
    • 描述网络驱动器,使用 network drive。
  2. 对于网络管理相关:
    • 具体指网络管理员,使用 network administrator。
    • 一般情况,使用 administrator 或 system administrator。

六、术语使用规范的重要性及影响

6.1 提高文档准确性

遵循术语使用规范可以避免因术语使用不当而产生的歧义。例如,准确区分 need 和 want,能让用户清楚了解操作的必要性和选择性,使文档传达的信息更加准确。

6.2 增强可读性和一致性

统一的术语使用规范使文档在整体上更加一致,读者在阅读过程中不会因为术语的随意变化而感到困惑。例如,始终使用 notification area 来指代任务栏右侧的区域,避免使用同义词,让读者能够快速理解文档内容。

6.3 便于跨语言交流

在全球化的背景下,技术文档可能会被翻译成多种语言。正确使用术语可以减少机器翻译时的误译情况,例如避免使用在不同语言中含义不同的缩写和符号,确保文档在不同语言环境下都能准确传达信息。

以下是一个 mermaid 流程图,展示了遵循术语使用规范的好处:

graph TD;
    A[遵循术语使用规范] --> B[提高文档准确性];
    A --> C[增强可读性和一致性];
    A --> D[便于跨语言交流];
    B --> E[减少歧义];
    C --> F[读者理解更顺畅];
    D --> G[降低误译风险];

总之,在技术写作中,严格遵循术语使用规范是非常重要的。它不仅能够提升文档的质量,还能为读者提供更好的阅读体验,促进技术信息的有效传播。无论是在日常的技术文档撰写,还是在专业的技术交流中,都应该时刻牢记这些规范,确保所使用的术语准确、清晰、一致。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值