推荐词汇表
为帮助确保文档的一致性,技术写作团队推荐以下措辞选择。
& (和号)
在标题、文本、导航、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。
您选择(而不是勾选或启用)和清除(而不是取消选择或禁用)复选框。
click (点击)
不要使用 click。请改用 select,用于按钮、链接、菜单项和列表。
Select 适用于更多设备,而 click 更特定于鼠标。
currently (当前)
谈论产品或其功能时,不要使用 currently。文档描述的是产品现状。
禁用
不要使用 disable。它暗示残疾是一种不受欢迎或消极的状态。
请改用 turn off 或 toggle off。
对于更具技术性的功能,开发团队有时会使用 disable,在这种情况下,使用该术语是可以的。
earlier (更早)
谈论版本号时使用 earlier。
使用
在 Docker Desktop 4.1 及更早版本中。
而不是
在 Docker Desktop 4.1 及更低版本中。
easy, easily (简单,轻易)
对您来说容易的事情,对其他人来说可能并不容易。尽量从句子中删除这个词,因为通常可以在没有它的情况下传达相同的含义。
e.g. (例如)
不要使用。请改用 for example 或 such as 等短语。
启用
不要使用 enable。它暗示残疾是一种不受欢迎或消极的状态。
请改用 turn on 或 toggle on。
对于更具技术性的功能,开发团队有时会使用 enable,在这种情况下,使用该术语是可以的。
execute (执行)
尽可能避免使用。请改用 run。
later (更晚)
谈论版本号时使用 later。
使用
在 Docker Desktop 4.1 及更高版本中。
而不是
在 Docker Desktop 4.1 及更高版本中…… 或 在 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 (选项卡) 与 view (视图)
提及 UI 中的主要部分时使用 view。提及 UI 中的子部分时使用 tab。
例如,在 Docker Desktop 中,Images 视图和 Local 选项卡。
toggle (开关)
您打开或关闭一个开关。例如:
打开深色模式开关。
upgrade (升级)
描述更高的订阅级别时使用 upgrade
vs (对)
不要使用 vs 或 vs. 作为 versus 的缩写;请改用未缩写的 versus。
we (我们)
尽量避免使用 we,而是专注于用户如何在 Docker 中完成某事。
使用
当您有需要组织的工作时,请使用小部件。
而不是
我们为您创建了添加小部件的功能。
wish (希望)
不要使用。请改用 want。