這份格式指南旨在協助您決定如何為社群範本庫準備範本。本風格指南的依據是 Google Material Design 寫作原則。簡單來說，這些是：
- 保持精簡
- 保持精簡並切中要點
- 清楚地向使用者說明
- 提供必要詳細資料
- 為所有閱讀程度撰寫內容
- 以人為本：為人類而寫，而非機器人
請遵循下列規範，確保所有範本的外觀一致，並協助使用者瞭解如何使用範本。
資訊
這些規範適用於範本編輯器的「資訊」分頁中的項目。
名稱
代碼管理工具使用者在代碼管理工具使用者介面和社群範本庫中，都會看到範本名稱。這項資訊會顯示在範本詳細資料頁面的頂端，並會顯示在範本清單中。
- 請使用貴公司/機構名稱和範本的功能名稱：機構名稱 範本名稱。
- 使用標題大小寫格式。
- 使用描述功能的詞彙。
- 除非獲得相關機構的授權，否則請勿在範本名稱中使用「官方」一詞。
範例： MyCompany 轉換評估代碼、MyCompany 廣告活動 ID 變數
說明
範本說明是範本的說明，會顯示在詳細資料頁面上，簡要說明範本功能。
- 以簡明扼要的句子說明範本的用途。
- 清楚說明您的範本可為使用者帶來哪些好處。例如：「Example.com 目標對象建立工具範本可協助您根據網站訪客建立新的目標對象名單。」
- 避免使用專業術語。
- 加入其他資訊、說明文件和支援服務的連結。
圖示
在代碼管理工具和社群範本庫中，範本圖示會以縮圖的形式顯示。
- 使用 PNG、JPEG 或 GIF 圖片格式。
- 圖片應為正方形，大小不得小於 48 x 48 像素，且不得大於 96 x 96 像素。
- 檔案大小不得超過 50 KB。
- 除非獲得相關機構授權，否則請勿使用官方公司標誌。
- 欄位
- 使用範本編輯器的「欄位」分頁新增表單元素，例如文字輸入欄、核取方塊等。
欄位
這些樣式規範適用於範本編輯器的「欄位」分頁。
參數名稱
這是欄位在範本編輯器中顯示的名稱，但不會向使用者顯示。名稱應描述所用資料的類型。將參數名稱格式設為 lowerCamelCase。範例： userName、customerID、shoppingCartValue。
欄位標籤
欄位標籤包括顯示名稱欄位、核取方塊文字和相關項目。
- 英文標題應採用句首字母大寫格式。
- 愈短愈好。
- 文意要明確。
- 使用常用字詞。
說明文字
說明文字是資訊內容，會以工具提示的形式顯示，協助使用者在範本欄位中輸入有效值。盡可能提供輸入範例，並說明如何使用範本欄位，或提供特定值的效果。
- 英文標題應採用句首字母大寫格式。
- 簡明扼要，但要保持人性。你可以使用縮寫字詞，並以第二人稱 (你) 書寫。
- 支援的欄位類型
- 允許使用基本 HTML 格式。例如：
<strong>、<em>。
支援的欄位類型
類型 |
說明 |
|---|---|
| 文字輸入 | 輸入文字。這種型別的範本參數值會是可能參照變數的字串。在代碼管理工具使用者介面中顯示的文字輸入小工具，可以是單行文字欄位或多行輸入內容。 |
| 下拉式選單 | 下拉式選單，只能選取單一項目做為範本參數的值。除非有充分理由，否則請依字母順序列出項目。 |
| Checkbox | 核取方塊輸入。此類型的範本參數值會是布林值：勾選為 true，未勾選為 false。 |
| 圓形按鈕 | 無線電輸入。這種類型的範本參數會在代碼管理工具使用者介面中顯示選項清單，使用者只能選擇其中一個選項做為範本參數的值。 |
| 簡單表格 | 簡易表格輸入內容。表格中的每個儲存格都可以直接編輯，且每個儲存格只能是下列兩種類型：文字輸入或下拉式選單。此類型範本參數的值是物件陣列：每個物件會編碼一列，物件中的每個鍵都必須是資料欄名稱之一，而物件中的每個值都是對應儲存格的值。 |