内容中的 UI 元素
目录
在编写涉及按钮、字段、菜单、对话框或其他用户界面 (UI) 元素的文档时，请使用本指南。它解释了如何格式化 UI 术语、编写以任务为中心的说明，以及如何一致而清晰地引用常见的 UI 模式。
格式化 UI 元素名称
对 UI 元素的可见名称使用粗体格式
- 按钮
- 对话框
- Windows
- 标签页
- 菜单项
- 列表项
- 表单标签
- 章节标题
例如：
选择创建，然后填写名称字段。
除非产品名称或功能在 UI 中完全作为标签出现，否则请勿加粗。
大写
- 按照 UI 中显示的资本化方式。
- 如果 UI 标签全部大写或不一致，请在文档中使用句首大写以提高可读性。
编写以任务为中心的说明
在可能的情况下，根据用户尝试执行的操作而非他们应选择的内容来指导用户。这使得文档更具目标导向性，并能更好地适应 UI 更改。
| 这样做 | 避免这样做 |
|---|---|
| 展开高级选项部分。 | 选择拉链以展开高级选项部分。 |
| 为容器选择一个基础镜像。 | 选择一个下拉菜单并选择一些内容。 |
对 UI 元素使用正确的介词
根据您引用的 UI 元素类型选择正确的介词。
| 介词 | 与……一起使用 | 示例 |
|---|---|---|
| 在 | 对话框、字段、列表、菜单、窗格、窗口 | 在名称字段中，输入您的项目名称。 |
| 在 | 页面、选项卡、工具栏 | 在设置选项卡上，选择常规。 |
使用一致的 UI 元素术语
在引用 Docker 产品中的元素时使用这些标准术语
| 首选术语 | 用于指代... |
|---|---|
| 按钮 | 可点击的操作元素（例如，启动） |
| 字段 | 输入文本或选择值的位置 |
| 菜单 / 菜单项 | 下拉或导航选项 |
| 下拉菜单 | 下拉菜单项 |
| 上下文切换器 | 专用于切换云模式 |
| 选项卡 | 窗口或页面内的可选视图 |
| 对话框 | 用于确认或选项的弹出窗口 |
| 部分 | 页面上内容的逻辑分组 |
| 列表 / 列表项 | 可滚动的可选条目列表 |
| 切换 | 二进制控件（开/关） |
| 复选框 | 多选控件 |
| 工具提示 | 鼠标悬停时出现的文本 |
最后，不要说“点击控件”，而要说“选择创建按钮”。