# 準備插件

{% hint style="info" %}
您必須先確保您開發的插件符合我們的[《Eagle 開發者政策》](https://developer.eagle.cool/plugin-api/zh-tw/distribution/developer-policies)。
{% endhint %}

## 插件命名

插件命名至少須符合以下規範：

* **明確的命名**\
  插件的名稱應該能夠清楚地揭示其主要功能或用途，讓使用者在瀏覽插件時能立即理解該插件的用途。例如，一個可以幫助使用者組織書籤的插件可以命名為「書籤整理大師」，而不應該使用模糊不清的名稱如「超級工具」。
* **字數限制**\
  為了確保插件名稱的簡潔性，我們建議插件名稱不應超過12個中文字。過長的名稱可能會使使用者感到困惑，並影響插件在列表中的顯示。
* **名詞而非動詞**\
  插件的名稱應該以名詞為主，而非動詞。這可以幫助使用者更好地理解插件的功能。例如，「圖片編輯器」會比「編輯圖片」更適合作為插件的名稱。
* **英文命名規範**\
  如果您的插件名稱使用英文，應該每個單詞首字母大寫，除非是特定用詞。例如，應該寫為「Image Editor」而非「image editor」。
* **插件名稱應該遵循** [**Apple Style Guide**](https://help.apple.com/applestyleguide/#/apsgb744e4a3?sub=apdca93e113f1d64) **的規範**
  * ✅ 以下合適的插件名稱
    * `Bulk Image Downloader` 此插件名稱清楚地表明了其功能是大量下載圖片。
    * `Duplicate Image Finder` 這個名稱明確地指出了插件的功能是查找重複的圖片。
    * `Image Metadata Editor V2` 此名稱明確地說明了插件的功能是編輯圖片的元數據，並且是版本2。
  * ❌ 以下不建議的插件名稱
    * `Extension For Pics` 此名稱過於籠統且無法提供插件的任何功能資訊。
    * `Adobe Image Organizer` 除非你擁有Adobe的授權，否則不應該在名稱中使用專有名稱。
    * `Image#Sorter` 此名稱使用了特殊字符#，可能會導致程式碼錯誤或難以理解。

***

## 插件描述

插件描述需至少符合以下規範：

* **簡潔明確的描述**\
  插件的描述應該在兩句話內就能清楚地解釋出其主要功能和用途。例如，一個用於壓縮圖片檔案的插件，適合的描述可能是「一鍵壓縮各種主流格式圖片，節省素材佔用空間。」不適合的描述可能是「超強、超棒的工具，讓你的設計工作變得更好。」
* **字數限制**\
  為了保持描述的簡潔，我們建議插件的描述不應超過40個中文字。過長的描述可能會使使用者感到冗長且難以理解。
* **適當的關鍵字使用**\
  您的插件描述應著重於功能和用途，不應在其中塞入與插件無關的其他關鍵字。舉例來說，如果您的插件是用於管理筆記，那麼描述中應避免出現像是「遊戲」或「音樂」等與插件無關的詞彙。

***

## 插件 Icon

{% hint style="info" %}
我們幫你設計了一個 Icon 產生器，你可以在 [這裡](https://www.figma.com/community/file/1301113485954941759) 找到他。
{% endhint %}

插件 Icon 至少符合以下規範：

* **使用模版設計**\
  為了保持插件中心的風格和色調的一致性，您應使用我們官方提供的模版來設計您的插件圖標。這樣可以確保您的插件與插件中心的整體美學風格保持一致。
* **圖標留白**\
  您的插件圖標周圍應該有一定的留白，這樣可以使圖標在插件中心列表中更容易被識別出來。例如，如果您的圖標是一個藍色的圓形，那麼您應該在圓形的邊緣與圖標邊界之間留出一定的空白區域，而非讓圓形填滿整個圖標。
* **高解析度**\
  發布至插件中心的插件 Icon 解析度至少 256 × 256 像素(px)，且為 `PNG` 格式。

{% hint style="info" %}
**尋求幫助**

如果您覺得設計 Icon 不是您擅長的，試著至 [社群](https://discord.gg/QUkvmAGRbX) 詢問幫忙。
{% endhint %}

***

## 插件封面圖

<figure><img src="https://3610077812-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fs4bjQFr3EFnc58JiXhsg%2Fuploads%2Fgit-blob-dc1fc23e82aa2d68de7e70128b8af1624013f65b%2Fimage.png?alt=media" alt=""><figcaption><p>詳情頁面的圖片範例</p></figcaption></figure>

您的封面截圖會顯示在插件中心的列表以及詳情頁面中，使用者可以點擊並瀏覽它們，以在安裝前更詳細地了解您的插件提供的功能。您可以提供一張封面圖，而在說明中可以提供更多細節。我們建議至少添加三張在詳細說明中，以方便使用者了解您的插件提供的功能及使您的插件詳情屏起來更加美觀。

***

## 提供給審閱開工作人員的必要訊息

如果您的插件需要額外的設定，像是 API Token，啟動特定的系統設定，或是開啟其他第三方應用程式，請提供一個 README 檔案作為說明文件，並將其放置在您插件的根目錄當中，供審閱的工作人員參考。