這份樣式指南可協助您決定如何針對社群範本庫準備範本。此樣式指南是以 Google 質感設計撰寫原則為依據。簡單來說,這些因素包括:
- 簡單扼要
- 保持精簡並切中要點
- 清楚說明使用者的需求
- 傳達重要詳細資訊
- 寫入所有朗讀層級的資料
- 重視人類:撰寫人類,而非機器人
請遵守以下規範,確保所有範本的外觀和風格一致,並協助使用者瞭解如何運用您的範本。
資訊
這些規範適用於範本編輯器「資訊」分頁中的項目。
名稱
在代碼管理工具使用者介面和社群範本庫中,範本使用者會看到範本名稱。範本會顯示在範本詳細資料頁面的頂端,並且在範本列出時顯示。
- 請使用您的公司/機構名稱和範本的函式名稱:「Organization Name」(範本名稱)。
- 請使用字首大寫。
- 使用可描述功能的字詞。
- 除非相關機構授權,否則請勿在範本名稱中使用「官方」一詞。
範例:MyCompany 轉換評估代碼、MyCompany 廣告活動 ID 變數
說明
範本說明是範本所示的範本說明,提供範本功能的簡短摘要。
- 請使用簡明扼要的句子來說明範本的用途。
- 清楚說明您的範本對使用者的助益。例如:「Example.com 目標對象建立工具範本可協助您根據網站訪客建立新的目標對象名單。」
- 避免使用專業術語。
- 請提供其他資訊、說明文件和支援連結。
圖示
在代碼管理工具和社群範本庫中,範本圖示會顯示為縮圖。
- 請使用 PNG、JPEG 或 GIF 格式的圖片格式。
- 圖片應為正方形,大小不得小於 48 像素 x 48 像素,但不可超過 96 像素 x 96 像素。
- 檔案大小不得超過 50 KB。
- 除非取得相關機構授權,否則請勿使用官方的公司標誌。
- 欄位
- 使用「範本編輯器」的「欄位」分頁新增表單元素,例如文字輸入、核取方塊等。
欄位
這些樣式規範適用於範本編輯器的 [欄位] 分頁。
參數名稱
這是指顯示在範本編輯器中的欄位名稱,而不是向使用者顯示的名稱。名稱應清楚說明所用資料類型。將參數名稱的格式設為 lowerCamelCase
。範例:userName、customerID、shoppingCartValue。
欄位標籤
欄位標籤包含顯示名稱欄位、核取方塊文字和相關項目。
- 英文標題應採用句首字母大寫格式。
- 愈短愈好。
- 文意要明確。
- 使用一般字詞。
說明文字
說明文字是資訊內容,以工具提示的形式協助使用者,在範本欄位中輸入有效的值。提供範例輸入 (可以的話),並說明範本欄位的使用方式,或是提供特定值的影響。
- 英文標題應採用句首字母大寫格式。
- 簡明扼要,但要以人為本。你可以使用合約,和第 2 名 (你) 一起撰寫,
- 支援的欄位類型
- 可使用基本的 HTML 格式。範例:
<strong>
、<em>
。
支援的欄位類型
類型 |
說明 |
---|---|
輸入文字 | 輸入文字。這種範本參數的值將是可能參照變數的字串。在代碼管理工具使用者介面中顯示的文字輸入小工具可以是單行文字欄位或多行輸入內容。 |
下拉式選單 | 只能選取單一項目做為範本參數值的下拉式選單。除非必要,否則系統會按照字母順序列出項目。 |
核取方塊 | 核取方塊。這類範本參數的值將為布林值:true 代表已勾選,false 代表未勾選。 |
圓形按鈕 | 無線電輸入。這種範本參數會在「代碼管理工具」使用者介面中顯示選項清單,且使用者只能挑選其中一個做為範本參數的值。 |
簡易表格 | 簡易的資料表輸入。您可以編輯表格中的每個儲存格,且每個儲存格只能採用兩種類型:文字輸入或下拉式選單。這種類型的範本參數值是物件陣列,每個物件會將特定列編碼,物件中的每個鍵都必須是其中一欄名稱,而物件中的每個值都是對應儲存格的值。 |