Google Workspace 外掛程式的 UI 樣式指南

Google Workspace 外掛程式應與其擴充的代管應用程式樣式和版面配置一致。應使用熟悉的控制項和行為,以自然方式擴充 UI。本文所述的指南將說明處理文字、圖片、控制項和品牌宣傳等元素,以提升優質使用者體驗。

如果外掛程式開啟的獨立網頁,且屬於外掛程式作業不可或缺的一部分 (例如外掛程式的設定頁面),請確認這些網頁同樣遵循這些樣式規範。

文字和圖片

本節將說明如何在外掛程式中正確使用文字和圖片。

外掛程式名稱

您必須在專案資訊清單中設定外掛程式名稱,或是在設定要發布的外掛程式時設定外掛程式名稱。這個名稱會顯示在許多地方,例如 Google Workspace Marketplace 清單和選單中。選擇名稱時:

  • 使用首字母大寫。
  • 避免使用標點符號,尤其是括號 (除非是品牌的一部分)。
  • 盡量簡短:最多不超過 15 個字元。系統可能會在 Google Workspace Marketplace 清單和其他位置自動截斷全名。
  • 請勿在外掛程式名稱中加入「Google」、「Gmail」或其他 Google 產品名稱。
  • 請勿在外掛程式名稱中加入「外掛程式」一詞。
  • 留下版本資訊。

寫作風格

不需要您另外撰寫。大多數操作都應透過圖像、版面配置和簡短標籤清楚傳達。如果您發現某些外掛程式需要比短標籤提供的資訊更詳盡,最好的做法是另外建立一個網頁來說明您的外掛程式,並連結到它。

編寫 UI 文字時:

  • 應採用句首字母大寫格式,特別是按鈕、標籤和資訊卡動作。
  • 偏好簡短易懂的文字,不含術語或縮寫。

通用和資訊卡動作

如果您在外掛程式中使用通用動作資訊卡動作,這些項目會以選單項目的形式顯示在您定義的資訊卡中。您可以選擇這些選單要用於這些動作的文字。選擇要使用的文字時:

  • 避免使用只是重複外掛程式名稱的選單文字。
  • 以動作字詞開頭為每個選單項目,例如「執行」、「設定」或「建立」。
  • 描述工作,而非動作顯示的 UI 元件。
  • 如果動作會啟動工作流程,且沒有說明其用途的單一動詞,請將其命名為「Start」。
  • 選單項目數量應保持小,以避免強迫使用者捲動瀏覽大型清單。如果您要實作更多動作,請考慮使用多張資訊卡,每種資訊卡各有不同的操作。

錯誤訊息

發生問題時,請務必使用簡單明瞭的語言。從使用者的角度說明問題,並提供修正建議。

  • 禁止使用者查看程式碼擲回的例外狀況。請改用 try...catch 陳述式攔截例外狀況,然後顯示使用者容易理解的錯誤訊息。
  • 發布之前,請確認外掛程式不會在 UI 中顯示偵錯資訊。

教學型內容

您可能想設計顯示說明資訊的資訊卡,或解釋外掛程式的運作方式。如果您正在為外掛程式建構說明內容,請記得:

  • 盡可能在項目符號或編號清單中顯示操作說明。請透過明確參照已命名 UI 元素,引導使用者前往最終結果。
  • 請確認您的操作說明清楚說明任何需求,例如以特定方式設定試算表。
  • 也可以加入外部說明內容的連結,例如支援網頁。

映像檔

外掛程式中使用的圖片為內建圖示類型之一,或是網址指定的公開代管圖片。使用代管的映像檔時,請確認這些映像檔的人都能存取。

控制選項

本節提供互動式小工具的使用者體驗指南。

按鈕

使用按鈕控制使用者介面的主要動作,而非其他小工具。

  • 大多數的文字按鈕標籤應以動詞開頭。
  • 在大多數情況下,按鈕列最多只能包含三個按鈕。

裝飾文字

DecoratedText 小工具可讓您使用圖示、按鈕或切換按鈕呈現文字內容。

  • 文字內容應採用句首大寫的格式。
  • 如果 DecoratedText 小工具的文字超出可用空間,則會遭到截斷。因此,請盡可能縮短文字內容。

選取輸入內容

您可以在外掛程式中使用各種選擇輸入小工具:下拉式選擇方塊、核取方塊和圓形按鈕。

  • 當使用者可以選取多個選項時,請使用核取方塊,或完全不選取任何選項。 必須選取一個選項時,請使用圓形按鈕 (或選取選單)。 嘗試在使用者介面中節省空間時,請使用下拉式選單提供替代項目清單。
  • 指派給每個選項的文字應採用句首大寫格式。
  • 避免使用選取變更來觸發重大且難以反向的動作,因為使用者常會在選取項目時出錯。請考慮新增可讀取目前選取值的按鈕,並觸發動作。
  • 如果是下拉式選單,請按字母順序或依所有使用者可理解的邏輯機制排序選項 (例如從週日或週一開始,依序顯示星期幾)。
  • 將特定選取輸入小工具中的選項數量限制為合理的數量。如果選項太多,使用者可能會覺得小工具難以使用。在這種情況下,請考慮將選項拆分成不同的類別和多個小工具。

文字輸入

文字輸入內容提供使用者輸入字串資料的地方。

  • 請勿使用文字輸入,讓使用者輸入一組特定的可能項目。請改用下拉式選單選取項目。
  • 使用提示和建議,可協助使用者以正確的格式和內容輸入文字。
  • 如果輸入的文字超過幾個字詞,請使用多行文字輸入。

品牌宣傳

本節提供在外掛程式介面中加入品牌宣傳元素的使用者體驗指南。

你的外掛程式

如果你想在外掛程式 UI 中加入品牌宣傳元素,請採用簡潔明瞭的原則。 這麼做可讓使用者聚焦於你的外掛程式功能。

  • 外掛程式的所有層面都必須符合品牌宣傳指南
  • 請勿加入「Google」、「Gmail」或其他 Google 產品名稱。
  • 請勿加入 Google 產品圖示 (即使圖示經過修改也一樣)。
  • 請勿在品牌宣傳文字中加入「附加」字樣。
  • 品牌宣傳文字的長度不得超過幾個字。

Google Workspace Marketplace

設定發布用的外掛程式時,您必須提供許多圖形和文字資產,以便建立 Google Workspace Marketplace 商店資訊。

商店資訊和這些素材資源的所有層面都必須符合品牌宣傳規範