推荐词汇表
为帮助确保文档的一致性,技术写作团队推荐以下词汇选择。
& (和号)
在标题、正文、导航、UI 文本或目录中,不要使用 &
代替 and
。
above
尽量避免在文档页面中引用示例或表格时使用 above
。如果需要,请使用 previous
。
例如
在上一个示例中,狗有跳蚤。
account name
不要使用。请改用 username
(用户名)。
admin
首次使用时请写全 administrator
。如果 admin
是 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
谈论产品或其功能时,不要使用 currently
。本文档描述的是产品当前的状态。
disable
不要使用 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
不要使用 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 versus view
指代 UI 中的主要部分时,使用 view
(视图)。指代 UI 中的子部分时,使用 tab
(选项卡)。
例如,在 Docker Desktop 中,**镜像** 视图和 **本地** 选项卡。
toggle
您打开或关闭切换开关。例如
打开深色模式切换开关。
upgrade
在描述更高级的订阅层级时,使用 upgrade
(升级)
vs
不要使用 vs
或 vs.
作为 versus 的缩写;请改用未缩写的 versus
(对比)。
we
尽量避免使用 we
,而应专注于用户如何在 Docker 中执行某项操作。
使用
当您有想要组织的工作时,请使用小组件。
不要使用
我们创建了一个功能供您添加小组件。
wish
不要使用。请改用 want
(想要)。