推荐词汇表
为确保文档的一致性,技术写作团队推荐使用以下措辞。
& (and 符号)
在标题、正文、导航、UI 文本或目录中,不要使用 & 代替 and。
above (上方)
在文档页面中引用示例或表格时,尽量避免使用 above。如果必须使用,请改用 previous (上一个)。
例如:
在上一个示例中,这只狗有跳蚤。
account name (账户名)
不要使用。请改用 username (用户名)。
admin
首次使用时请完整拼写为 administrator (管理员)。如果它是 UI 标签或其他元素的名称,则可以使用 admin。
allows
不要使用。请改用 lets (让)。
as of this writing (截至本文撰写时)
避免使用。因为文档本身已经暗示了这一点。该短语还可能过早地透露产品或功能策略,或不适当地暗示产品或功能可能会发生变化。
below (下方)
在文档页面中引用示例或表格时,尽量避免使用 below。如果必须使用,请改用 following (以下)。
例如:
在以下示例中,这只狗有跳蚤。
checkbox (复选框)
checkbox 为一个单词。不要使用 check box。
您是 select (选中,而不是 check 或 enable) 和 clear (清空,而不是 deselect 或 disable) 复选框。
click (点击)
不要使用 click。请改用 select (选择),适用于按钮、链接、菜单项和列表。
Select 适用于更多设备,而 click 更具体地指鼠标操作。
currently (当前)
在谈论产品或其功能时,不要使用 current。文档描述的是产品在今天的状态。
disable (禁用)
不要使用 disable。这暗示了“残疾”是一种不太理想或负面的状态。
请改用 turn off (关闭) 或 toggle off (切换关闭)。
在某些涉及更技术性的功能时,如果开发团队使用了 disable,那么在这些情况下可以使用该术语。
earlier (较早版本)
在谈论版本号时使用 earlier。
使用:
In Docker Desktop 4.1 and earlier. (在 Docker Desktop 4.1 及较早版本中。)
不要使用:
In Docker Desktop 4.1 and lower. (在 Docker Desktop 4.1 及更低版本中。)
easy, easily (简单,轻松地)
对你来说简单的事情对别人来说可能并不简单。尝试从句子中去掉这个词,因为通常可以在不使用它的情况下传达相同的含义。
e.g.
不要使用。请改用 for example (例如) 或 such as (比如) 等短语。
enable (启用)
不要使用 enable。这暗示了“残疾”是一种不太理想或负面的状态。
请改用 turn on (打开) 或 toggle on (切换打开)。
在某些涉及更技术性的功能时,如果开发团队使用了 enable,那么在这些情况下可以使用该术语。
execute (执行)
尽可能避免使用。请改用 run (运行)。
later (较晚版本)
在谈论版本号时使用 later。
使用:
In Docker Desktop 4.1 and later. (在 Docker Desktop 4.1 及较晚版本中。)
不要使用:
In Docker Desktop 4.1 and higher… 或 In Docker Desktop 4.1 and above… (在 Docker Desktop 4.1 及更高版本中……)
please (请)
在正常解释如何使用产品时,不要使用 please,即使你在解释一项困难的任务。也不要使用短语 please note (请注意)。
register (注册)
在谈论创建账户时,使用 sign up (注册) 代替 register。
repo
不要使用。请改用 repository (仓库)。
respectively (分别)
避免使用 respectively,请改用更精确的表达。
scroll (滚动)
避免使用。如果上下文清晰,请使用动词短语,例如 move through (移动浏览) 或 navigate to (导航至)。
sign in (登录)
使用 sign in 代替 sign on、signon、log on、logon 或 log in、login。如果用户界面使用了不同的词,则使用那些词。
使用 sign in to 代替 sign into。
sign up (注册)
在谈论创建账户时,使用 sign up 或 create account 代替 register。
tab versus view (标签页与视图)
在指代 UI 中的主要部分时使用 view (视图)。在指代 UI 中的子部分时使用 tab (标签页)。
例如,在 Docker Desktop 中,Images (镜像) 视图和 Local (本地) 标签页。
toggle (切换)
您是 turn on (打开) 或 turn off (关闭) 一个 toggle (切换开关)。例如:
Turn on the dark mode toggle. (打开暗色模式切换开关。)
upgrade (升级)
在描述更高的订阅层级时使用 upgrade。
vs
不要使用 vs 或 vs. 作为 versus 的缩写;请改用完整的 versus (与/对)。
we (我们)
尽量避免使用 we,而是专注于用户如何在 Docker 中执行某项操作。
使用:
Use widgets when you have work you want to organize. (当您有想要组织的工作时,请使用小部件。)
不要使用:
We created a feature for you to add widgets. (我们为您创建了一个添加小部件的功能。)
wish (希望)
不要使用。请改用 want (想要)。