內容中的 UI 元素
目錄
在編寫涉及按鈕、欄位、選單、對話方塊或其他使用者介面 (UI) 元素的文件時，請使用本指南。它解釋瞭如何格式化 UI 術語、編寫以任務為中心的說明，以及如何一致而清晰地引用常見的 UI 模式。
格式化 UI 元素名稱
對 UI 元素的可見名稱使用粗體格式
- 按鈕
- 對話方塊
- Windows
- 標籤頁
- 選單項
- 列表項
- 表單標籤
- 章節標題
例如：
選擇建立，然後填寫名稱欄位。
除非產品名稱或功能在 UI 中完全作為標籤出現，否則請勿加粗。
大寫
- 按照 UI 中顯示的資本化方式。
- 如果 UI 標籤全部大寫或不一致，請在文件中使用句首大寫以提高可讀性。
編寫以任務為中心的說明
在可能的情況下，根據使用者嘗試執行的操作而非他們應選擇的內容來指導使用者。這使得文件更具目標導向性，並能更好地適應 UI 更改。
| 這樣做 | 避免這樣做 |
|---|---|
| 展開高階選項部分。 | 選擇拉鍊以展開高階選項部分。 |
| 為容器選擇一個基礎映象。 | 選擇一個下拉選單並選擇一些內容。 |
對 UI 元素使用正確的介詞
根據您引用的 UI 元素型別選擇正確的介詞。
| 介詞 | 與……一起使用 | 示例 |
|---|---|---|
| 在 | 對話方塊、欄位、列表、選單、窗格、視窗 | 在名稱欄位中，輸入您的專案名稱。 |
| 在 | 頁面、選項卡、工具欄 | 在設定選項卡上，選擇常規。 |
使用一致的 UI 元素術語
在引用 Docker 產品中的元素時使用這些標準術語
| 首選術語 | 用於指代... |
|---|---|
| 按鈕 | 可點選的操作元素（例如，啟動） |
| 欄位 | 輸入文字或選擇值的位置 |
| 選單 / 選單項 | 下拉或導航選項 |
| 下拉選單 | 下拉選單項 |
| 上下文切換器 | 專用於切換雲模式 |
| 選項卡 | 視窗或頁面內的可選檢視 |
| 對話方塊 | 用於確認或選項的彈出視窗 |
| 部分 | 頁面上內容的邏輯分組 |
| 列表 / 列表項 | 可滾動的可選條目列表 |
| 切換 | 二進位制控制元件（開/關） |
| 複選框 | 多選控制元件 |
| 工具提示 | 滑鼠懸停時出現的文字 |
最後，不要說“點選控制元件”，而要說“選擇建立按鈕”。