35、技术术语使用规范指南

技术术语使用规范指南

技术术语使用规范指南

1. 滚动相关术语

1.1 滚动描述限制

除非设备上有传统控件(如微软 Arc Touch 鼠标的滚轮按钮),否则不要用“scroll”描述与设备的交互。

1.2 滚动条相关

  • 滚动条定义 :滚动条(scroll bar)是一种控件,能让用户查看超出窗口边界的信息,它包含滚动箭头(scroll arrow)和滚动框(scroll box)。
  • 术语使用规范
    • 不要用“arrow”指代滚动箭头,以免与上下箭头混淆。
    • 不要用“slider”或“slider box”作为滚动框的同义词。
    • 不要用“gray”或“shaded area”指代滚动条。

1.3 搜索与替换

  • 不要用“search, search and replace”来描述查找和替换功能,要用“find and replace”。
  • “search, find, and replace”用作动词,不用作名词,例如用“search through your document”而不是“search your document”。
正确用法 错误用法
Find the word “gem” and replace it with “jewel.” Do a search and replace.
Search through your document for comments in red. Search your document for comments in red.

2. 菜单与安全相关术语

2.1 二级菜单

二级菜单(secondary menu)指用户选择右侧有小箭头的命令时出现的菜单。面向普通用户的内容中不要使用该术语,若需强调菜单工作方式是产品特性,用“submenu”。在软件开发人员相关内容中,仅在讨论创建菜单且上下文中不能用“submenu”时使用。

2.2 安全更新

  • 不要用“security patch”,用“security update”描述针对产品特定安全漏洞的广泛发布的修复程序。
  • 安全漏洞根据严重程度评级,在微软安全公告中显示为“critical, important, moderate, or low”。

3. 选择与相关术语

3.1 选择操作

  • “select”用于标记文本、单元格等将进行用户操作的项目,如复制文本。标记的项目称为“selection”或“selected text, cells, items”等。
  • “select”也用于在复选框中添加勾选标记,或在列表框、组合框列表中选择项目。
  • 在对话框中选择其他选项时,用“click”而不是“select”。
  • 不要用“highlight”或“pick”作为“select”的同义词。

3.2 选择光标

一般不用“selection cursor”,用“cursor”或“pointer”代替,它指用户在窗口或对话框中工作处出现的标记或指示所选内容的标记。

4. 架构与服务包相关术语

4.1 面向服务的架构

面向服务的架构(service-oriented architecture)注意连字符,是一种使用策略、实践和框架使应用功能以服务集形式提供和消费的软件架构。首次完整拼写后可以使用缩写“SOA”。

4.2 服务包

  • 服务包(service pack)指产品所有更新的累积集,包括自产品发布以来发现的问题修复,可能还包含客户请求的设计更改或功能。不要用“service release”,它是过时术语。
  • 不要将服务包与更新汇总(update rollup)混淆,更新汇总包含多个错误修复,但不如服务包全面。
  • 一般情况下,“service pack”全部拼写且不首字母大写;提及特定产品的服务包时,首字母大写,首次提及除非空间有限要全部拼写,之后用缩写“SP”标识特定服务包。
  • 讨论多个服务包中包含的功能时,不要使用“or later”“or greater”等可能指未发布服务包或产品的短语,分别列出每个已发布的服务包。
  • 讨论早期服务包中包含的功能时,用“with SP2 or earlier service packs”避免暗示该功能适用于产品的所有早期版本。

以下是服务包使用示例的对比:
|正确用法|错误用法|
| ---- | ---- |
|Requirements: Windows 7 SP1
This program requires Windows 7 Service Pack 1.
If you are using Windows Vista with SP2 or earlier service packs, you can…
If you are using Windows Vista with SP2 or SP1, you can…
This service pack includes…|This SP addresses all known security vulnerabilities.
We recommend that you install service pack 2.
We recommend that you install Service Pack 2.0.
If you are using Windows Vista with SP2 or earlier, you can…
If you are using Windows Vista with SP1 or later, you can…
You can install more than one Service Pack.|

5. 其他术语使用规范

5.1 “set up, setup, Setup”

  • 作为动词时是两个单词“set up”,如“Have everything unpacked before you set up your computer.”。
  • 作为形容词和名词时是一个单词“setup”,如“The setup time should be about 15 minutes.”;“Your office setup should be ergonomically designed.”。
  • 当指安装程序时,“Setup”首字母大写,如“Run Setup before you open other programs.”;“Insert the Setup CD in the CD drive.”。

5.2 “set”与“specify”

  • 避免使用“set”和“specify”这类笼统指代用户操作的词,最好明确用户应采取的具体操作。
  • 不要用“set”表示在对话框中输入或选择值的用户操作,因为“set”含义多,对非英语母语者较难理解,若必须笼统指代此类操作,可用“specify”。但软件开发人员内容中可以用“set”表示输入或选择属性值的操作。
graph LR
    A[用户操作] --> B{选择合适术语}
    B -->|明确操作| C[具体描述操作]
    B -->|笼统指代| D{受众是否为开发者}
    D -->|是| E[可用set表示属性操作]
    D -->|否| F[用specify代替set]

5.3 设置相关

在面向普通用户的内容中,用“setting”或“value”指代用户可设置的特定值,如字体的特定颜色。不要用“property”表示设置或值,除非讨论明确标识为属性的内容。

5.4 机顶盒

机顶盒(set-top box)注意连字符,不要用缩写“STB”,它是放在电视机顶部实现双向通信的计算机的标准行业术语。

5.5 阴影显示

用“shaded”描述复选框在一组选项中选择设置混合时的外观,而不用“grayed”或“dimmed”。阴影外观表示之前勾选的某些选项可能使部分选择与其他部分不同。

5.6 外壳

“shell”作为名词可在面向技术受众的内容中使用,面向普通用户的内容中不要使用。除非别无选择,否则不要用“shell”或“shell out”作动词,用更精确的术语,如“create a new shell”或“return to the operating system”。

5.7 发布相关

不要用“ship”指代向公众发布软件或服务,用“release”,例如“Windows 7 was released in October 2009.” 而不是“Windows 7 shipped in October 2009.”。

5.8 快捷方式相关

  • “shortcut”作为形容词或名词时是一个单词,除非用户界面中大写,否则用小写。不要用作超链接的同义词。
  • “shortcut key”在面向普通用户的内容中不要使用,用“keyboard shortcut”。在软件开发人员内容和关于自定义用户界面的内容中,若需区分访问键(access key)和快捷键,用“shortcut key”表示执行命令的键组合并给出定义,用“access key”表示访问菜单项的键序列并给出定义。

5.9 快捷菜单

快捷菜单(shortcut menu)在用户右键单击项目时出现,列出仅与用户单击项目相关的命令。若必须按名称提及此菜单,可以使用“shortcut menu”。在操作步骤中,仅当这样做有助于用户在用户界面中定位项目时使用。

5.10 “should”与“must”

  • “should”仅用于描述推荐但可选的用户操作,“must”用于描述必需的用户操作。
  • 不要用“should”表示可能性,尽可能表达确定性,无法确定时用“may”或重新表述。
  • 可以使用其他方式指定推荐或要求,如推荐操作可用“we recommend”,必需操作可用祈使语气。避免使用“Microsoft recommends”和“it is recommended”。
正确用法 错误用法
You should periodically back up your data.
Your computer must have at least 128 MB of RAM to run this program, but for best performance your computer should have at least 256 MB.
In Windows, you cannot have multiple versions of a file with the same name. To save different copies of a document, you must save each copy with a different file name.
When you click Submit, the data is sent to Microsoft, and you will get a confirmation email message within 24 hours.
We recommend at least 256 MB of RAM to run this program.
Free technical support is available when you register with Microsoft.
When you click Submit, the data is sent to Microsoft, and you should get a confirmation email message within 24 hours.
Microsoft recommends at least 256 MB of RAM to run this program.
It is recommended at least 256 MB of RAM to run this program.

5.11 关机相关

  • “shut down”作为动词时是两个单词,作为形容词和名词时是一个单词“shutdown”,Windows 开始菜单上的“Shut down”命令是两个单词。
  • “shut down”指操作系统的有序关闭,不要用于指代关闭计算机电源,也不要用作“close”或“exit”的同义词。

5.12 登录与注册相关

  • 用“sign in”和“sign out”指代互联网账户用户会话的创建和结束,“sign in to”(不是“sign into”)MyMSN 账户、互联网服务提供商账户或 XML 网络服务。用“log on”和“log off”描述计算机或企业内部网用户账户的用户会话创建和结束。
  • 用“connect”“make a connection”等短语指代计算机物理连接到网络(企业内部网或互联网)的行为。
  • “sign on”仅作为“single sign on (SSO)”的一部分使用,用户操作仍是“signing in”。“sign off”仅非正式地用于指代获得批准,否则除非这些术语出现在用户界面中,否则不要使用。
  • “sign out”用于指代关闭互联网上的用户会话,“sign up”用于指代注册服务。这些术语仅用作形容词时加连字符。

5.13 简单表述

不要用“simply”表示某事容易做,它通常不必要,若用户觉得任务不简单,可能听起来有 condescending 意味。若需要类似含义,用“just”。

5.14 网站相关

  • “site”指作为一个整体开发的网页集合,如微软网站、MSDN 库网站等。必要时为清晰起见用“website”代替“site”。信息在网站上用“on a website”,网站地址用“at http://www”。
  • “site map”是两个单词。

5.15 大小操作

“size”可以用作动词,如“size the window”,也可以用“resize”表示改变大小。

5.16 平板电脑相关

不要用“slate”作为计算机或 PC 的修饰词,一般用最通用的术语描述设备,如“computer”或“PC”,除非需要与其他类型设备区分。“Slate”通常指没有集成物理键盘的平板电脑。

5.17 滑块控件

滑块(slider)是一种控件,使用户能在连续的可能值范围内设置值,如屏幕亮度、鼠标点击速度或音量。在软件开发人员内容中,有时称为“trackbar control”。不要将滚动框或进度指示器称为滑块。

5.18 小型大写字母

不要对键名或“A.M.”和“P.M.”使用小型大写字母(small caps),在 HTML 等代码中难以指定。可以使用“small caps”术语,必要时首次提及用“small capitals”并加上“often referred to as ‘small caps’”。

5.19 智能卡

指代智能卡或智能卡技术的通用引用时用小写“smart card”,作为专有名称一部分时大写,但在一般提及智能卡实现时不大写。

5.20 智能手机

“smartphone”是一个单词,一般用最通用的术语描述设备,如“phone”,除非需要强调手机的移动性,此时用“mobile phone”。仅当需要区分智能手机和其他类型手机时用“smartphone”。除非需要写包含手机、笔记本电脑和平板电脑等的通用类别,否则不要用“device”指代手机。

5.21 管理单元

“snap-in”是在微软管理控制台上下文中运行的程序,在需要标题大写的上下文中,大写为“Snap-in”。

5.22 软拷贝

不要用“soft copy”,它是类比“hard copy”形成的行话,用更具体的术语,如“electronic document”或“file”。

5.23 软件即服务

软件即服务(software as a service, SaaS)是通过互联网消费而非本地安装的软件。通常供应商管理云基础设施,包括硬件、存储、操作系统和应用程序。组织为使用服务付费。首次完整拼写后可以使用缩写“SaaS”,不要大写为“SAAS”。

5.24 软件加服务

软件加服务(software-plus-services)是一种计算模型,包括本地安装的完整软件包和互联网交付或托管的应用程序。一般用“Microsoft Cloud Services”具体指代微软提供的云平台和服务。使用“software-plus-services”时,在正文和标题中全部拼写并小写,作为名词和修饰词时都加连字符,该术语用单数动词和代词。在需要标题大写的上下文中,“plus”不大写。

正确用法 示例
The software-plus-services approach combines client software and services delivered over the Internet. -
Software-plus-Services -

6. 技术术语使用规范总结与补充说明

6.1 术语使用规范总览

为了更清晰地展示各术语的使用规范,下面以表格形式进行总结:
|术语|使用规范|
| ---- | ---- |
|scroll|除非设备有传统控件,否则不用于描述与设备交互|
|滚动条相关(scroll bar、scroll arrow、scroll box)|明确各部分定义,避免用易混淆的同义词|
|search, search and replace|用 find and replace 描述查找替换功能,作动词使用|
|secondary menu|普通内容少用,必要时用 submenu;开发者内容特定情况使用|
|security patch|用 security update 描述安全修复|
|select|用于标记文本等操作,对话框选其他选项用 click,避免用 highlight 和 pick 作同义词|
|selection cursor|用 cursor 或 pointer 代替|
|service-oriented architecture|注意连字符,首次完整拼写后可用 SOA|
|service pack|区分与 update rollup,按规则大小写和使用缩写|
|set up, setup, Setup|动词用 set up,形容词和名词用 setup,安装程序首字母大写|
|set, specify|避免笼统使用,非开发者内容尽量明确操作,开发者内容可用 set 表示属性操作|
|setting|面向普通用户指代特定设置值|
|set-top box|注意连字符,不用 STB 缩写|
|shaded|描述复选框外观|
|shell|技术受众内容可用作名词,避免作动词|
|ship|用 release 代替表示发布软件或服务|
|shortcut|一个单词,避免作超链接同义词|
|shortcut key|普通内容用 keyboard shortcut,开发者等内容按需区分 access key 使用|
|shortcut menu|按需使用,操作步骤中有助于定位时使用|
|should, must|should 表推荐可选操作,must 表必需操作,避免用 should 表可能性|
|shut down, shutdown, Shut Down|动词用 shut down,形容词和名词用 shutdown,命令首字母大写,不用于关电源等|
|sign in, sign out, sign on, sign up|按规则用于不同登录、注册场景,作形容词时加连字符|
|simply|用 just 代替表示容易做|
|site, website|必要时用 website 替代 site,site map 是两个单词|
|size|可作动词,resize 表示改变大小|
|slate|不用于修饰计算机或 PC|
|slider|作控件名称,不用于指代滚动框等|
|small caps|不用于键名等,可使用该术语并按需解释|
|smart card|通用引用小写,专有名称部分大写|
|smartphone|按需使用,一般用 phone 或 mobile phone|
|snap-in|特定上下文大写为 Snap-in|
|soft copy|用电子文档或文件等具体术语|
|software as a service (SaaS)|首次完整拼写后可用 SaaS,不大写为 SAAS|
|software-plus-services|按规则大小写和使用连字符|

6.2 操作步骤示例

在实际应用中,遵循这些术语使用规范能使表达更准确清晰。以下是一些操作步骤示例,展示如何正确使用这些术语:

调整屏幕亮度操作
graph LR
    A[打开设置] --> B[找到显示选项]
    B --> C[找到亮度设置]
    C --> D[移动滑块调整亮度]

在这个操作中,“滑块”(slider)的使用符合规范,明确指出这是用于设置连续值的控件。

查找并替换文档内容操作
  1. 打开文档。
  2. 选择“编辑”菜单(若有)。
  3. 点击“查找和替换”(find and replace)选项。
  4. 在“查找内容”框中输入要查找的内容,如“gem”。
  5. 在“替换为”框中输入要替换的内容,如“jewel”。
  6. 点击“全部替换”或逐个替换。

这个操作步骤中,准确使用了“find and replace”来描述查找替换功能,避免了使用“search and replace”可能带来的混淆。

6.3 避免常见错误

在使用这些术语时,还需注意避免一些常见错误,下面通过表格列举一些常见错误及正确用法:
|常见错误|正确用法|
| ---- | ---- |
|用 arrow 指代滚动箭头|用 scroll arrow|
|用 slider 指代滚动框|用 scroll box|
|用 security patch 描述安全更新|用 security update|
|用 highlight 代替 select|用 select|
|用 service release 指代服务包|用 service pack|
|用 set 笼统表示对话框输入或选择值|非开发者内容用 specify,开发者内容按需用 set|
|用 soft copy 指代电子文档|用 electronic document 或 file|

6.4 总结与应用建议

遵循这些技术术语使用规范,能够提高技术文档、操作说明等内容的准确性和专业性,避免因术语使用不当而造成的误解。在实际写作过程中,要时刻牢记这些规范,根据不同的受众和场景选择合适的术语。同时,不断回顾和总结这些规范,确保在各种技术交流和文档编写中都能正确使用相关术语。

总之,准确使用技术术语是技术交流和文档编写的基础,希望通过本文的介绍,能帮助大家更好地掌握这些术语的使用规范,提升技术表达的质量。

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值