Docker 擴充功能的設計指導方針

在 Docker，我們的目標是建置可整合到使用者現有工作流程的工具，而不是要求他們採用新的工作流程。強烈建議您在建立擴充功能時遵循這些指導方針。我們會根據這些要求審查並核准您在市集上的發佈。

以下是建立擴充功能時要參考的簡單檢查清單

• 是否容易上手？
• 是否易於使用？
• 需要時是否容易獲得幫助？

建立與 Docker Desktop 一致的體驗

使用 Docker Material UI 主題

確保您的擴充功能圖示在淺色和深色模式下都可見。

確保導覽行為與 Docker Desktop 的其餘部分一致。新增標題以設定擴充功能的上下文。

避免嵌入終端機視窗。Docker Desktop 相較於 CLI 的優勢在於我們有機會向使用者提供豐富的資訊。盡可能利用此介面。

原生建置功能

• 為了不中斷使用者的流程，請避免使用者必須導覽到 Docker Desktop 之外（例如 CLI 或網頁）才能執行某些功能的情況。請改為建置 Docker Desktop 原生的功能。

  

  

分解複雜的使用者流程

• 如果流程太複雜或概念太抽象，請將流程分解成多個步驟，每個步驟中都只有一個簡單的行動呼籲。這有助於新手使用者入門您的擴充功能。

  

• 如果有多個行動呼籲，請確保使用主要（實心按鈕樣式）和次要按鈕（外框按鈕樣式）來傳達每個動作的重要性。

  

新使用者入門

建立擴充功能時，請確保擴充功能和產品的初次使用者能夠理解其附加價值並輕鬆採用。請確保在擴充功能中包含上下文說明。

• 請確保所有必要的資訊都已新增至擴充功能市集以及擴充功能詳細資訊頁面。這應該包含

  • 擴充功能的螢幕截圖。螢幕截圖的建議大小為 2400x1600 像素。
  • 詳細說明，涵蓋擴充功能的用途、目標使用者以及運作方式。
  • 必要資源的連結，例如文件。

• 如果您的擴充功能具有特別複雜的功能，請在起始頁面新增示範或影片。這有助於初次使用者快速上手。

  

後續步驟？

• 探索我們的設計原則。
• 查看我們的UI 樣式指南。
• 瞭解如何發佈您的擴充功能。