技术写作术语使用规范
在技术写作中,准确使用术语和遵循特定的语言规范至关重要,它能确保信息的清晰传达,避免读者产生误解。以下是一些常见术语的使用规则和建议。
一、“highlight”的使用
一般情况下,除非你明确指的是某些产品中用户可用于强调所选内容的高亮功能,否则不要使用“highlight”,而应使用“select”。例如:
-
正确用法
:Drag the pointer to select the text you want to format.(拖动指针选择你要格式化的文本。)
-
错误用法
:Drag the pointer to highlight the text you want to format.
对于已选中的内容,应称为“selection”,而非“highlight”。比如:
-
正确用法
:To extend the selection, press F6.(要扩展所选内容,按 F6。)
-
错误用法
:To extend the highlight, press F6.
不过,当需要进行图形化描述时,可以使用“highlight”作为动词,告知用户选择诸如文字处理文档中的文本、电子表格中的单元格范围或数据库列表视图中的字段和记录等内容。同时,也可以用“highlight”来描述反显的外观。但在操作步骤中使用“highlight”作为动词时,要在步骤中包含“select”,以免用户在使用其他微软产品或服务时产生混淆。例如:
- Highlight the paragraph to select it.(高亮段落以选择它。)
- Highlight to select the range of cells you want to copy.(高亮以选择你要复制的单元格范围。)
- Programmers use reverse video to highlight special items on the screen.(程序员使用反显在屏幕上突出显示特殊项目。)
二、“hint”和“tip”的区分
不要将“hint”用作某种注释的标题,应使用“tip”。
三、“hi - res”和“high - resolution”
不要使用“hi - res”,应使用“high - resolution”。
四、“hit”的用法
“hit”可用于指从网页检索文件的次数。由于与网页关联的每个文件都算作一次“hit”,所以一次页面浏览可能会产生多次“hit”。若要指页面及其所有关联文件的下载次数,应使用“page view”或“page request”。另外,不要用“hit”来指按计算机键盘上的键这一动作,而应使用“press”。
五、“home directory”和“root directory”
不要使用“home directory”,应使用“root directory”来指代分层文件结构中的起始点。在 MS - DOS 和 Windows 中,根目录用反斜杠(\)表示。
六、“home page”的定义
“home page”指任何网站的主页,由网站所有者或创建者确定。一个网站可以有多个主页。例如,微软网站(www.microsoft.com)有一个主页,而微软网站内的其他子网站也有各自的主页。“home page”还指用户启动网页浏览器时首先显示的网页,不要使用“start page”。除非你指的是命令,否则提及主页时使用小写。
七、“honeypot”的使用注意
除非别无选择,否则不要使用“honeypot”,它属于行话。“honeypot”是一种安全程序,旨在用诱饵数据引诱和分散网络攻击者的注意力。这个术语可能难以翻译,还可能导致地缘政治或文化误解。在专门涉及网络诱饵技术的内容中,尽量避免直接提及;若无法避免,首次提及时要对该术语进行定义。
八、“host name”的写法
“host name”通常为两个单词,除非你指的是编程元素,如“HostName”属性。
九、“hosted service”和“hosting provider”
- “hosted service”是指由服务提供商托管并通过互联网提供给客户的服务、IT 解决方案或应用程序。
- “hosting provider”是指为多个客户提供可扩展基础设施服务的第三方服务提供商。必要时可以使用“cloud hosting provider”和“web hosting provider”来明确上下文或区分云服务提供商和网络主机(如 Go Daddy),但不要使用“hoster”。
十、“hot key”和“keyboard shortcut”
“hot key”是过时的术语,不要使用,应使用“keyboard shortcut”。
十一、“hot link”的使用禁忌
不要使用“hot link”,它是指程序之间的一种连接,可在一个数据库或文件中的信息更改时更新相关数据库或文件中的信息,不要用它来指代超链接。
十二、“hot spot”和“hotspot”
在面向技术受众的内容中,当指指针上定义用户确切指向位置的特定像素时,或指无线或 Wi - Fi 热点时,使用“hot spot”(两个单词);当指编程元素(如“HotSpot”类的元素)或遵循用户界面中的措辞时,使用“hotspot”(一个单词)。不要用“hot spot”或“hotspot”来指代超链接。
十三、“hotfix”的含义
“hotfix”是一个单词,用于描述由一个或多个文件组成的单个累积包,用于解决产品中的缺陷。“hotfix”针对特定的客户情况,可能不会在该客户组织之外分发。不要使用“QFE(quick fix engineering)”来描述“hotfix”。
十四、“hover over”的使用
“hover over”指的是一种空中手势,即短暂地将手指或手停留在特定位置以选择操作或与用户界面进行交互。例如:
- Hover over the item that you want until it’s selected.(将鼠标悬停在你想要的项目上,直到它被选中。)
- 对于新手计算机用户:To select an object, hold your finger over it so that your finger hovers over the object until it is selected.(要选择一个对象,将手指放在它上面,使手指悬停在对象上直到它被选中。)
- To start the game, hold your hand out so that it hovers over the Start button.(要开始游戏,伸出手,使手悬停在“开始”按钮上。)
不过,尤其是在面向普通受众的内容中,不要用“hover”来指将鼠标指针短暂停留在界面项目上以查看定义或描述的动作,而应使用“point to”、“pause on”或类似的单词或短语。
十五、“how - to”和“how to”的用法
不要将“how - to”用作名词,作形容词时要加连字符。无论“how to”是否加连字符,在需要标题大写的上下文中,“to”都不要大写。例如:
-
正确用法
:
- how - to book(操作指南书籍)
- how - to article(操作指南文章)
- How to Format Your Hard Disk(标题大写:如何格式化你的硬盘)
- Writing a How - to Article(标题大写:撰写一篇操作指南文章)
-
错误用法
:
- The TechNet website has how - tos for system administrators.
- Writing a How - To Article(标题大写)
十六、“HTML”和“HTTP”的缩写使用
- “HTML”是“Hypertext Markup Language(超文本标记语言)”的缩写,不要拼写出来。
- “HTTP”是“Hypertext Transfer Protocol(超文本传输协议)”的缩写,该协议出现在 URL 的开头:“http://”。“http://”和 URL 的其余部分使用小写。除非你在讨论协议或 URL,或者你的受众可能不熟悉该缩写,否则不要拼写出来。如果确定用户能理解上下文,在网页地址中不必包含“http”,但如果在互联网地址中使用其他协议(如 FTP),则必须使用该协议。
十七、“Hub”的提及方式
除非绝对必要,否则不要将其称为“Hub”。在操作步骤中,使用“Hub”的名称,如“In Marketplace…”或“In Pictures…”,来指代“Hub”的首页以进行用户操作。若确实提及“Hub”,则要大写“Hub”。例如:
-
正确用法(适用于 Windows Phone)
:In Pictures, find a picture and tap to open it.(在“图片”中,找到一张图片并点击打开它。)
- The Pictures Hub is where you go to see all the pictures on your phone and the latest pictures your friends have posted to Windows Live.(“图片”中心是你查看手机上所有图片以及朋友发布到 Windows Live 上的最新图片的地方。)
十八、“hybrid cloud”和“hybrid model”
“hybrid cloud”是一种云基础设施,它结合了公共云、社区云和私有云,每个独立实体相互连接,以实现数据和应用程序的可移植性。它能满足组织独特的应用程序和数据存储需求以及隐私问题。对于熟悉云技术的技术受众可以使用“hybrid cloud”,对于其他受众,谈论“hybrid model”可能更有用。由于这些部署模型尚未被广泛理解,首次提及时要进行定义。
十九、“hyperlink”和“link”
“hyperlink”可参考“link”。
二十、“i.e.”的替代
不要使用“i.e.”,应使用“that is”。
二十一、“IA - 32 - based”和“32 - bit/x86”
“IA - 32 - based”是过时的术语,应使用“32 - bit”或“x86”。
二十二、“IA - 64 - based”和“Itanium - based”
不要将“IA64”用作“64 - bit”、“x64”或“amd64”的同义词。“IA64”是仅用于 Windows Server 2008 和 Windows Server 2008 R2 的架构,在 Windows 的下一个版本中将不再可用,可使用“Itanium - based”代替。
二十三、“I - beam”的使用
按所示方式大写并加连字符“ I - beam”。除非有必要描述指针形状对其功能的影响,否则不要提及“I - beam 指针”。例如:When you click text, the pointer looks like an I - beam.(当你点击文本时,指针看起来像一个“I - 形”。)
二十四、“icon”的使用规则
“icon”仅用于描述用户可以选择并打开的对象的图形表示,如驱动器、磁盘、文件夹、文档或程序。提及图标时,图标名称要用粗体。例如:Click the Word icon.(点击“Word”图标。)
在程序内部,不要将“icon”用于图形对话框选项或出现在功能区、工具栏、工具箱或窗口其他区域的选项。对于通过图形而非标签文本标识的用户界面元素,应使用最具描述性的术语,如“button”(按钮)、“box”(框)或“check box”(复选框)。若没有其他标识标签,可使用“symbol”(符号)来指代图形,如“warning symbol”(警告符号)。
二十五、“iconize”的替代
不要使用“iconize”,应使用“shrink to an icon”或“minimize”。
二十六、“if”、“when”和“whether”的区别
为避免歧义,“if”用于表达条件;“whether”用于表达不确定性;“when”用于需要准备的情况或表示时间的流逝。在网络的非正式写作中,可以使用“if”来表达不确定性。例如:
-
正确用法
:
- If you do not know whether a network key is needed, contact your network administrator.(如果你不知道是否需要网络密钥,请联系你的网络管理员。)
- The printer might insert stray characters if the wrong font cartridge is selected.(如果选择了错误的字体墨盒,打印机可能会插入乱码。)
- When Setup is complete, restart your computer.(安装完成后,重启你的计算机。)
- To find out whether TrueType fonts are available…(要查明是否有 TrueType 字体……)
- To find out if TrueType fonts are available…(非正式风格:要查明是否有 TrueType 字体……)
-
错误用法
:
- If you do not know if a network key is needed, contact your network administrator.
- The printer might insert stray characters when the wrong font cartridge is selected.
另外,不要使用“whether or not”来表达不确定性。例如:
-
正确用法
:
- With Internet Explorer, you can save webpages and view them later, whether you are connected to the Internet or not.(使用 Internet Explorer,无论你是否连接到互联网,都可以保存网页并稍后查看。)
- With Internet Explorer, you can save webpages and view them later, even if you are not connected to the Internet.(使用 Internet Explorer,即使你未连接到互联网,也可以保存网页并稍后查看。)
-
错误用法
:If you are not sure whether or not a network key is needed, contact your network administrator.
二十七、“illegal”的使用场景
仅在特定情况下使用“illegal”,如软件上的提示“Do not make illegal copies of this disk”(不要非法复制此磁盘),或在本地内容中提及违反当地法律,或提及违反国际法的情况。除某些合适的情况外,“licensed”和“unlicensed”可能是更好的选择。不要用“illegal”来表示“invalid”或“not valid”。例如:
-
正确用法
:
- The queue path name is not valid.(队列路径名无效。)
- Chords cannot be composed while a segment is playing.(在一段音乐播放时不能编写和弦。)
-
错误用法
:
- The queue path name is illegal.
- It is illegal to compose chords while a segment is playing.
二十八、“image map”的写法
除非你指的是编程地图(如图像映射类的元素),否则使用“image map”(两个单词)。
二十九、“imbed”的替代
不要使用“imbed”,应使用“embed”。
三十、“impact”的词性使用
“impact”仅用作名词,作动词时应使用“affect”或其他同义词。例如:
-
正确用法
:Sending inappropriate email can affect your career adversely.(发送不恰当的电子邮件会对你的职业生涯产生不利影响。)
-
错误用法
:Sending inappropriate email can impact your career adversely.
三十一、“in”和“into”的区别
“in”表示在……的界限、范围或区域内,或从外部到内部的某一点;“into”通常意味着移动到……的内部。例如:
- A word is in a paragraph, but you move the text into the document.(一个单词在段落中,但你将文本移动到文档中。)
- Data is in a cell on a worksheet.(数据在工作表的单元格中。)
- You edit the cell contents in the formula bar.(你在公式栏中编辑单元格内容。)
- A file name is in a list box.(文件名在列表框中。)
- A workstation is in a domain, but resources are on servers.(工作站在域中,但资源在服务器上。)
- You open multiple windows in a document.(你在文档中打开多个窗口。)
- You insert the disk into the disk drive.(你将磁盘插入磁盘驱动器。)
- You run programs with, on, or under an operating system, not in one.(你在操作系统上运行程序,而不是在操作系统“里面”运行程序。)
三十二、“in order to”的使用
在一般写作中,“in order to”可能显得冗长,因此可以直接使用“to”。但在需要机器翻译的内容中,使用“in order to”可以避免较短形式“to”经常导致的歧义。
三十三、“inactive”和“inactive state”的使用
使用“inactive”或“inactive state”来指代未打开和运行的窗口、程序、文档、文件、设备或屏幕部分,而不要使用“not current”。
三十四、“inbound”和“incoming”
除非别无选择,否则不要用“inbound”来表示消息的传递,应使用“incoming”。
三十五、“incent”的替代
除非别无选择,否则不要使用“incent”,应使用“motivate”(激励)、“encourage”(鼓励)等动词,或使用“incentive”(激励措施)等名词。例如:
-
正确用法
:This pricing should encourage users to buy the new version.(这种定价应该会鼓励用户购买新版本。)
-
错误用法
:This pricing should incent users to buy the new version.
三十六、“incoming”和“outgoing”
使用“incoming”和“outgoing”来指正在下载或发送的电子邮件消息。除非别无选择,否则不要使用“inbound”和“outbound”。
三十七、“increment”的使用
在面向软件开发人员、网页开发人员和信息技术专业人员的内容中,“increment”作为动词仅表示增加一个或按指定间隔增加;作为名词,它指指定的间隔。在其他内容中,只要意思明确,也可以在非技术意义上使用“increment”。
三十八、“indent”和“indentation”的用法
“indent”用于指单次缩进的情况,例如“hanging indent”(悬挂缩进)、“nested indent”(嵌套缩进)、“negative indent”(负缩进)或“positive indent”(正缩进)。不要用“outdent”来表示“negative indent”,也不要用“indention”来表示“indent”。“indentation”仅用于指代缩进的一般概念。
三十九、“indenting”和“outdenting”的替代
不要使用“indenting”或“outdenting into the margin”,应使用“extending text into the margin”(将文本延伸到页边距)或“indenting to the previous tab stop”(缩进至上一个制表位)。
四十、“independent content provider”的定义
“independent content provider”用于指为在线信息服务(如 MSN 或美国在线)提供信息的企业或组织,首次提及时要完整拼写。
四十一、“index”的复数形式
一般情况下,“index”的复数形式使用“indexes”,仅在数学表达式的上下文中使用“indices”。
四十二、“infrastructure as a service (IaaS)”的使用
“IaaS”指的是由云服务提供商管理并通过互联网提供给客户的灵活计算能力,如服务器、存储和网络。在“infrastructure as a service (IaaS)”模型中,硬件供应(如计算、存储和网络)由提供商控制,但客户可以控制操作系统和应用程序。首次提及时完整拼写“infrastructure as a service (IaaS)”,之后可以使用“IaaS”,但不要大写为“IAAS”。需要注意的是,不要将“IaaS”与电力等公共事业进行比较。
四十三、“initialize”和“initiate”的用法
“initialize”是一个技术术语,通常指准备磁盘或计算机以供使用,或将变量设置为初始值,不要用它来表示启动程序或打开计算机。“initiate”不要用于表示启动程序,应使用“start”。
四十四、“inline”的写法
“inline”为一个单词,不要加连字符。“Inline styles”(内联样式)用于级联样式表中,以覆盖样式表本身的样式。内联样式通过使用“STYLE”参数嵌入到标签中。
四十五、“input”的使用
“input”不要用作动词,应使用“type”或其他合适的动词。在面向普通受众的内容中,除非别无选择,否则不要将“input”用作名词。例如:
-
正确用法
:Word moves existing characters to the right as you type new text.(当你输入新文本时,Word 会将现有字符向右移动。)
- To verify the text that was entered…(要验证输入的文本……)
-
错误用法
:Word moves existing characters to the right as you input new text.
- To verify the input that was entered…
四十六、“input device”的使用
“input device”可泛指将用户输入发送到计算机或控制台的设备,如鼠标、笔、球、手写笔、键盘、游戏杆、游戏控制器等。当你可以明确指出具体设备时,不要将“input device”用作鼠标或其他上述设备的同义词。
四十七、“input/output”的使用
在面向普通受众的内容中,首次提及时完整拼写“input/output”,之后缩写为“I/O”。在面向技术受众的内容中,首次提及“ I/O”时无需完整拼写。
四十八、“input/output control”的使用
首次提及时完整拼写“input/output control”,后续提及可缩写为“I/O control”或“IOCTL”,仅用于面向技术受众的内容。
四十九、“insecure”的替代
不要使用“insecure”来表示“not secure”,应使用“not secure”。
五十、“insertion point”的替代
不要使用“insertion point”,应使用“cursor”(光标)。
五十一、“inside”的使用
使用“inside”代替口语化的“inside of”。
五十二、“install”的词性使用
“install”一般用于指将硬件或软件添加到计算机系统中,不要将“install”用作名词,应使用“installation”。
五十三、“instant message”和“IM”的使用
当受众期望非正式语气时,“IM”可作为“instant message”或“instant messaging”的名词或修饰语使用。一般情况下,首次提及时完整拼写“instant message”或“instant messaging”。通常不要将“instant message”用作动词,应使用“send an instant message”;不要将“IM”用作动词,应使用“send an IM”。不过,“IM”可在移动 UI 内容中用作动词,或与另一个单字短语形成平行结构,例如“Tap a name to call or IM a contact.”(点击一个名字来呼叫或即时通讯联系人。)
需要注意的是,使用“IM”等缩写在内容本地化时不一定能节省空间。例如,在许多语言中,“instant message”没有缩写形式,翻译可能超过 23 个字符。
五十四、“instantiate”的替代
除非别无选择,否则不要使用“instantiate”,应使用“create an instance of (a class)”(创建一个类的实例)。如果必须使用“instantiate”,其直接宾语必须是类的名称或对类的一般引用,是“instantiate a class”(实例化一个类),而不是“instantiate an object”(实例化一个对象)。
五十五、“insure”和“ensure”的区别
“insure”仅用于指保险相关内容,其他情况使用“ensure”。
五十六、“Intel - based”的定义
“Intel - based”用于区分基于英特尔 IA - 32 或安腾架构处理器的计算机与基于其他架构的计算机。
五十七、“interface”的词性使用
“interface”仅用作名词,如“user interface”(用户界面)和“application programming interface”(应用程序编程接口)。在“user interface”前使用“on”作为介词。只有在上下文明确的情况下,才单独使用“interface”。“interface”作为动词属于行话,应使用“interact”(交互)或“communicate”(通信)。例如:
-
正确用法
:
- It is easy to use the Internet to communicate with various interest groups.(使用互联网与各种兴趣小组进行交流很容易。)
- The interface is so intuitive that even first - time users learn quickly.(该界面非常直观,即使是初次使用的用户也能很快学会。)
- The color can be adjusted on the user interface.(可以在用户界面上调整颜色。)
-
错误用法
:
- It is easy to use the Internet to interface with various interest groups.
- The color can be adjusted in the user interface.
总之,在技术写作中严格遵循这些术语使用规范,能够使你的文档更加专业、准确,便于读者理解。希望以上内容对你有所帮助。
以下是一个简单的 mermaid 流程图,展示了选择文本时“highlight”和“select”的正确使用判断流程:
graph TD;
A[要选择文本] --> B{是否为特定高亮功能};
B -- 是 --> C[使用 highlight];
B -- 否 --> D[使用 select];
同时,为了更清晰地对比一些易混淆术语的正确和错误用法,我们制作了以下表格:
|术语|正确用法|错误用法|
| ---- | ---- | ---- |
|highlight|Drag the pointer to select the text you want to format.|Drag the pointer to highlight the text you want to format.|
|hint|Use tip as a heading for a type of note.|Use hint as a heading for a type of note.|
|hit|Refer to the number of times a file from a webpage has been retrieved. Use page view or page request for page downloads. Use press to refer to key - pressing.|Use hit to refer to the act of pressing a key on the computer keyboard.|
|home directory|Use root directory to refer to the starting point in a hierarchical file structure.|Use home directory to refer to the starting point in a hierarchical file structure.|
|hot key|Use keyboard shortcut.|Use hot key.|
|hot link|Don’t use it to refer to a hyperlink.|Use hot link to refer to a hyperlink.|
|icon|Use to describe graphic representation of selectable objects. Use bold for icon names. Don’t use for dialog options in programs.|Use icon for graphical dialog box options in programs.|
|iconize|Use shrink to an icon or minimize.|Use iconize.|
|impact|Use as a noun. Use affect as a verb.|Use impact as a verb.|
|in|A word is in a paragraph. You edit cell contents in the formula bar.|Incorrect usage not following the rules of in and into.|
|into|You move the text into the document. You insert the disk into the disk drive.|Incorrect usage not following the rules of in and into.|
|how - to|Use as an adjective. Don’t capitalize to in title capitalization contexts.|Use how - to as a noun. Capitalize to in title capitalization contexts.|
|i.e.|Use that is.|Use i.e.|
|IA - 32 - based|Use 32 - bit or x86.|Use IA - 32 - based|
|IA - 64 - based|Use Itanium - based.|Use IA64 as a synonym for 64 - bit, x64, or amd64.|
|icon|Click the Word icon. Use descriptive terms for UI elements without text labels.|Use icon for non - standard UI elements.|
|iconize|Shrink to an icon or minimize.|Iconize|
|if, when, whether|Use if for conditions, whether for uncertainty, when for time - related or preparatory situations. Don’t use whether or not for uncertainty.|Incorrect usage not following the rules of if, when, and whether.|
|illegal|Use in specific legal - related situations. Use licensed or unlicensed instead of illegal for invalid cases.|Use illegal to mean invalid or not valid.|
|image map|Use two words unless referring to programming maps.|Incorrect usage not following the rules of image map.|
|imbed|Use embed.|Use imbed.|
|impact|Use as a noun. Use affect as a verb.|Use impact as a verb.|
|in, into|A word is in a paragraph, move text into the document. Data is in a cell, insert disk into the drive.|Incorrect usage not following the rules of in and into.|
|in order to|Use to in general writing, in order to in machine - translated content to avoid ambiguity.|Incorrect usage not following the rules of in order to.|
|inactive|Use instead of not current for non - active items.|Use not current for non - active items.|
|inbound|Use incoming for message delivery.|Use inbound for message delivery.|
|incent|Use motivate, encourage, or incentive.|Use incent|
|incoming, outgoing|Use for email messages. Avoid inbound and outbound unless necessary.|Use inbound and outbound for email messages without necessity.|
|increment|Use as a verb to mean increase by one or an interval in technical content. Use in non - technical sense if meaning is clear.|Incorrect usage not following the rules of increment.|
|indent|Use for single indentation cases. Don’t use outdent or indention.|Use outdent for negative indent or indention for indent.|
|indenting, outdenting|Use extending text into the margin or indenting to the previous tab stop.|Use indenting or outdenting into the margin.|
|independent content provider|Spell out on first mention.|Don’t spell out on first mention.|
|index|Use indexes as the plural form in general, indices in math expressions.|Use indices in non - math contexts.|
|infrastructure as a service (IaaS)|Spell out on first mention, then use IaaS. Don’t compare with common utilities.|Don’t spell out on first mention. Compare with common utilities.|
|initialize|Use for preparing disk or setting variable initial value. Don’t use for starting programs or turning on computers.|Use initialize to mean start a program or turn on a computer.|
|initiate|Use start to refer to starting programs.|Use initiate to mean start a program.|
|inline|Use as one word. Don’t hyphenate.|Hyphenate inline.|
|input|Use type as a verb. Avoid using as a noun for general audiences unless necessary.|Use input as a verb. Use input as a noun for general audiences without necessity.|
|input/output|Spell out on first mention for general audiences, then use I/O. No need to spell out for technical audiences.|Incorrect usage not following the rules of input/output.|
|input/output control|Spell out on first mention, then abbreviate as I/O control or IOCTL for technical audiences.|Incorrect usage not following the rules of input/output control.|
|insecure|Use not secure.|Use insecure to mean not secure.|
|insertion point|Use cursor.|Use insertion point.|
|inside|Use inside instead of inside of.|Use inside of.|
|install|Use to add hardware or software. Use installation as a noun.|Use install as a noun.|
|instant message, IM|Spell out on first mention. Use send an instant message or send an IM. Use IM as a verb in mobile UI or parallel structures.|Incorrect usage not following the rules of instant message and IM.|
|instantiate|Use create an instance of (a class). If used, direct object must be a class name.|Use instantiate with an object as the direct object.|
|insure|Use for insurance - related content. Use ensure otherwise.|Use insure in non - insurance contexts.|
|interface|Use as a noun. Use interact or communicate as a verb. Use on before user interface.|Use interface as a verb. Use in before user interface.|
通过以上的规则和示例,你可以更准确地使用这些技术写作中的术语,避免常见的错误。在实际写作过程中,要时刻牢记这些规范,以提高文档的质量和专业性。
### 技术写作术语使用规范(续)
#### 五十六、部分术语的深入解析与对比
为了更深入地理解这些术语的使用规范,我们将对一些容易混淆的术语进行更详细的对比分析。
##### “if”、“when”和“whether”的详细区别
|术语|用法说明|示例|
| ---- | ---- | ---- |
|if|表达条件,在网络非正式写作中也可表达不确定性|If it rains tomorrow, we will stay at home.(如果明天下雨,我们将待在家里。)<br>To find out if there are any available seats...(要查明是否有可用的座位……)(非正式风格)|
|when|用于需要准备的情况或表示时间的流逝|When the alarm goes off, you should get up.(当闹钟响起时,你应该起床。)<br>When you finish your homework, you can watch TV.(当你完成作业后,你可以看电视。)|
|whether|表达不确定性,避免使用“whether or not”|I'm not sure whether I can attend the meeting.(我不确定我是否能参加会议。)<br>With this app, you can access your files whether you are online or offline.(有了这个应用程序,无论你是在线还是离线,都可以访问你的文件。)|
##### “in”和“into”的详细对比
|术语|用法说明|示例|
| ---- | ---- | ---- |
|in|表示在……的界限、范围或区域内,或从外部到内部的某一点|The pen is in the pencil - box.(钢笔在铅笔盒里。)<br>He works in a big company.(他在一家大公司工作。)|
|into|通常意味着移动到……的内部|She put the books into the bag.(她把书放进了包里。)<br>The water flows into the river.(水流入了河里。)|
#### 五十七、特殊情况与注意事项
在实际的技术写作中,还会遇到一些特殊情况,需要特别注意。
##### 缩写的使用
在使用缩写时,要考虑受众和内容的本地化问题。例如,“IM”在英语中可以作为“instant message”的缩写,但在许多其他语言中可能没有对应的缩写形式,翻译后的长度可能会超过预期。因此,在面向国际受众的内容中,首次提及时最好完整拼写术语,之后再根据情况决定是否使用缩写。
##### 行话和专业术语的处理
对于像“honeypot”、“instantiate”等行话和专业术语,除非你的受众是非常熟悉相关领域的专业人士,否则应尽量避免使用。如果必须使用,首次提及时要进行清晰的定义和解释,以确保读者能够理解。
#### 五十八、操作步骤中的术语使用
在编写操作步骤时,准确使用术语尤为重要,以下是一些常见操作场景中的术语使用建议。
##### 文件操作
- **选择文件**:使用“select”而不是“highlight”。例如,“Select the file you want to delete.”(选择你要删除的文件。)
- **复制和粘贴**:使用常见的表述,如“Copy the selected text and paste it into the new document.”(复制所选文本并将其粘贴到新文档中。)
- **保存文件**:“Save the file to your desired location.”(将文件保存到你想要的位置。)
##### 软件安装
- **安装软件**:“Install the software by following the on - screen instructions.”(按照屏幕上的说明安装软件。)
- **卸载软件**:“Uninstall the software from your computer if you no longer need it.”(如果你不再需要该软件,从你的计算机上卸载它。)
##### 网络操作
- **访问网页**:“Open your web browser and type the URL to access the website.”(打开你的网页浏览器,输入 URL 访问网站。)
- **下载文件**:“Download the file by clicking the download link.”(点击下载链接下载文件。)
#### 五十九、不同受众的术语使用策略
根据受众的不同,术语的使用也应有所调整。
##### 技术专业人员
对于技术专业人员,可以使用更专业和简洁的术语,如“IA - 32 - based”可直接使用“32 - bit”或“x86”,“IaaS”在首次完整拼写后可直接使用缩写。同时,可以适当使用一些行话和专业概念,但要确保其准确性。
##### 普通受众
对于普通受众,应尽量避免使用过于专业的术语和缩写。例如,用“instant message”代替“IM”,用更通俗易懂的语言解释复杂的概念。在描述操作步骤时,要详细、清晰,避免让读者产生困惑。
#### 六十、总结与建议
在技术写作中,准确使用术语是确保信息清晰传达的关键。通过遵循上述的术语使用规范,我们可以避免常见的错误,提高文档的质量和专业性。
为了帮助大家更好地掌握这些规范,以下是一个简单的检查清单:
1. 检查是否使用了准确的术语,避免使用过时或错误的术语。
2. 确保缩写的使用符合规范,首次提及时进行完整拼写。
3. 对于行话和专业术语,是否进行了适当的定义和解释。
4. 在操作步骤中,术语的使用是否准确、清晰。
5. 根据受众的不同,调整术语的使用策略。
同时,为了更直观地展示术语使用的流程,我们制作了以下 mermaid 流程图:
```mermaid
graph LR;
A[开始写作] --> B{确定受众};
B -- 技术专业人员 --> C[使用专业术语和缩写];
B -- 普通受众 --> D[使用通俗易懂的语言];
C --> E{检查术语准确性};
D --> E;
E -- 是 --> F[遵循操作步骤规范];
E -- 否 --> G[修正术语使用];
G --> F;
F --> H[检查缩写使用];
H -- 符合规范 --> I[检查行话和专业术语];
H -- 不符合规范 --> J[修正缩写使用];
J --> I;
I -- 已定义解释 --> K[完成写作];
I -- 未定义解释 --> L[定义和解释术语];
L --> K;
通过这个流程图,我们可以清晰地看到在技术写作中,从确定受众到最终完成写作的整个术语使用流程。在实际写作过程中,要不断回顾和检查这些步骤,确保文档的质量和专业性。希望以上内容能够帮助你在技术写作中准确使用术语,避免常见的错误。
超级会员免费看
58

被折叠的 条评论
为什么被折叠?



