推荐词汇表
为了确保文档的一致性,技术写作团队推荐使用以下措辞。
& (和号)
不要在标题、文本、导航、UI 文本或目录中使用&
代替and
。
上面
在引用文档页面中的示例或表格时,尽量避免使用上面
。如果需要,请使用前面
代替。
例如
在前面的示例中,狗身上有跳蚤。
账户名
不要使用。请使用用户名
代替。
管理员
首次使用时,请写出管理员
。如果它是 UI 标签或其他元素的名称,则可以使用admin
。
允许
不要使用。请使用允许
代替。
截至撰写本文时
避免使用,因为文章本身就暗示了这句话。此短语也可能过早地分享产品或功能策略,或不恰当地暗示产品或功能可能会发生变化。
下面
在引用文档页面中的示例或表格时,尽量避免使用下面
。如果需要,请使用下面
代替。
例如
在下面的示例中,狗身上有跳蚤。
复选框
使用一个词复选框
。不要使用复选框
。
您选择(而不是选中或启用)并清除(而不是取消选择或禁用)复选框。
点击
不要使用点击
。对于按钮、链接、菜单项和列表,请使用选择
代替。
选择适用于更多设备,而点击更具体地指鼠标操作。
当前
在谈论产品或其功能时,不要使用当前
。文档描述的是当前的产品。
禁用
不要使用禁用
。这暗示残疾是一种不太理想或负面的状态。
请使用关闭
或切换关闭
代替。
在涉及更多技术功能的情况下,开发团队有时会使用禁用
,在这种情况下,可以使用该术语。
较早的
在谈论版本号时,请使用较早的
。
使用
在 Docker Desktop 4.1 和更早版本中。
而不是
在 Docker Desktop 4.1 和以下版本中。
简单,容易
对你来说很简单的事情,对其他人来说可能并不简单。尽量从句子中删除这个词,因为通常可以在不使用它的情况下表达相同的含义。
例如
不要使用。请使用诸如例如
或例如
之类的短语。
启用
不要使用启用
。这暗示残疾是一种不太理想或负面的状态。
请使用打开
或切换打开
代替。
在涉及更多技术功能的情况下,开发团队有时会使用启用
,在这种情况下,可以使用该术语。
执行
尽可能避免使用。请使用运行
代替。
以后的
在谈论版本号时,请使用以后的
。
使用
在 Docker Desktop 4.1 和以后版本中。
而不是
在 Docker Desktop 4.1 和更高版本中……或在 Docker Desktop 4.1 和以上版本中……
请
在解释如何使用产品时,通常情况下不要使用请
,即使您正在解释一项困难的任务。也不要使用短语请注意
。
注册
在谈论创建帐户时,请使用注册
代替注册
。
仓库
不要使用。请使用仓库
代替。
分别
避免使用分别
,请改为更精确的描述。
滚动
避免使用。如果上下文清晰,请使用诸如浏览或导航到之类的动词短语代替。
登录
请使用登录
代替登录
、登录
、登录
、登录
或登录
、登录
。如果用户界面使用不同的词语,请使用那些词语。
请使用登录到
代替登录到
。
注册
在谈论创建帐户时,请使用注册
或创建帐户
代替注册
。
标签页与视图
在引用 UI 中的主要部分时,请使用视图
。在引用 UI 中的子部分时,请使用标签页
。
例如,在 Docker Desktop 中,**镜像**视图和**本地**标签页。
切换
您可以打开或关闭切换。例如
打开暗模式切换。
升级
在描述更高订阅级别时,请使用升级
与
不要使用与
或与
作为“与”的缩写;请使用完整的与
。
我们
尽量避免使用我们
,而应关注用户如何在 Docker 中执行操作。
使用
当您有要整理的工作时,请使用窗口小部件。
而不是
我们为您创建了一个添加窗口小部件的功能。
希望
不要使用。请使用想要
代替。