推荐单词表
为了帮助确保文档之间的一致性,技术写作团队推荐了这些措辞选择。
&(与号)
不要在标题、文本、导航、UI 副本或目录中使用&
“替代” 。and
多于
above
在引用文档页面中的示例或表格时尽量避免使用。如果需要,请改用previous
。
例如:
在前面的例子中,狗身上有跳蚤。
帐户名称
不要使用。相反,使用username
.
行政
写出administrator
第一次使用时的情况。admin
如果它是 UI 标签或其他元素的名称,则使用。
允许
不要使用。相反,使用lets
.
截至撰写本文时
避免,因为写作本身就暗示了这句话。该短语还可能过早地分享产品或功能策略,或者不恰当地暗示产品或功能可能会发生变化。
以下
尽量避免 below
引用文档页面上的示例或表格。如果需要,请改用 following
。
例如:
在下面的例子中,狗身上有跳蚤。
复选框
用一个词来表示 checkbox
。不要使用 check box
.
您选择(不是选中或启用)并清除(不是取消选择或禁用)复选框。
点击
不要使用 click
.相反,应 select
与按钮、链接、菜单项和列表一起使用。
选择适用于更多设备,而单击则更特定于鼠标。
现在
请勿currently
在谈论产品或其功能时使用。该文档描述了目前的产品。
取消选择
不要使用deselect
.相反,使用clear
.
禁用
不要使用disable
.意味着残疾是一种不太理想或消极的状态。
相反,请使用turn off
或toggle off
。
有时,开发团队使用 时会包含更多技术功能disable
,在这些情况下,可以使用该术语。
早些时候
earlier
在谈论版本号时使用。
使用:
在 Docker Desktop 4.1 及更早版本中。
代替:
在 Docker Desktop 4.1 及更低版本中。
容易,容易
对你来说可能容易的事情对其他人来说可能并不容易。尝试从句子中删除这个词,因为通常没有它也可以表达相同的含义。
例如
不要使用。相反,请使用for example
或 之类的短语such as
。
使能够
不要使用enable
.意味着残疾是一种不太理想或消极的状态。
相反,请使用turn on
或toggle on
。
有时,开发团队使用 时会包含更多技术功能enable
,在这些情况下,可以使用该术语。
执行
尽可能避免。代替使用run
。
之后
later
在谈论版本号时使用。
使用:
在 Docker Desktop 4.1 及更高版本中。
代替:
在 Docker Desktop 4.1 及更高版本中...或在 Docker Desktop 4.1 及更高版本中...
请
即使您正在解释一项困难的任务,也不要please
在解释如何使用产品的正常过程中使用。也不要使用这个短语please note
。
登记
sign up
在谈论创建帐户时使用而不是注册。
回购协议
不要使用。相反,使用repository
.
分别
相反,要避免respectively
并更加精确。
滚动
避免。如果上下文清晰,请使用动词短语,例如move through或navigator to 。
登入
使用, , , , 或,sign in
来代替。如果用户界面使用不同的词语,请使用这些词语。sign on
signon
log on
logon
log in
login
使用sign in to
而不是sign into
.
报名
在谈论创建帐户时使用sign up
或create account
代替。register
选项卡与视图
view
当引用 UI 中的主要部分时使用。tab
当引用 UI 中的子部分时使用。
例如,在 Docker Desktop 中,“图像”视图和“本地”选项卡。
切换
您打开或关闭开关。例如:
打开深色模式开关。
升级
upgrade
在描述更高订阅层时使用
与
不要使用vs
orvs.
作为 vs 的缩写;相反,请使用未缩写的versus
.
我们
尽量避免we
并关注用户如何在 Docker 中执行某些操作。
使用:
当您想要组织工作时,请使用小部件。
代替:
我们为您创建了一个添加小部件的功能。
希望
不要使用。代替使用want
。