内容中的 UI 元素

在编写涉及按钮、字段、菜单、对话框或其他用户界面 (UI) 元素的文档时,请参考本指南。本指南说明了如何格式化 UI 术语、编写以任务为中心的说明,以及如何一致且清晰地引用常见的 UI 模式。

格式化 UI 元素名称

对 UI 元素的可见名称使用粗体格式:

  • 按钮
  • 对话框
  • 窗口
  • 选项卡
  • 菜单项
  • 列表项
  • 表单标签
  • 章节标题

例如:

选择 创建,然后填写 名称 字段。

除非产品名称或功能在 UI 中恰好作为标签出现,否则不要将其加粗。

大小写

  • 遵循 UI 中显示的大小写格式。
  • 如果 UI 标签全部为大写或大小写不一致,请在文档中使用句子式大小写以提高可读性。

编写以任务为中心的说明

在可能的情况下,请根据用户的目标(而不仅仅是他们应选择的内容)来指导用户。这使得文档更具目标导向性,并能适应 UI 的更改。

应该这样做 避免这样做
展开 高级选项 部分。 选择“zippy”以展开 高级选项 部分。
为您的容器选择一个基础镜像。 选择一个下拉菜单并挑选某个内容。

对 UI 元素使用正确的介词

根据您引用的 UI 元素类型选择合适的介词。

介词 用于... 示例
in 对话框、字段、列表、菜单、窗格、窗口 名称 字段中,输入您的项目名称。
on 页面、选项卡、工具栏 设置 选项卡上,选择 常规

使用一致的 UI 元素术语

在引用 Docker 产品中的元素时,请使用以下标准术语:

首选术语 用于指代...
button 可点击的操作元素(例如 启动
field 输入文本或选择值的位置
menu / menu item 下拉菜单或导航选项
drop-down 下拉菜单项
context switcher 特定于在云模式下切换
tab 窗口或页面内的可选视图
dialog 用于确认或选项的弹出窗口
section 页面上内容的逻辑分组
list / list item 可滚动选择项列表
toggle 二进制控件(开/关)
checkbox 多选控件
tooltip 悬停时显示的文本

最后,与其说“点击控件”,不如说“选择 创建 按钮”。