Docker 擴充套件的設計指南

在 Docker,我們旨在構建能夠融入使用者現有工作流程的工具,而不是要求他們採用新的工作流程。我們強烈建議您在建立擴充套件時遵循這些指南。我們根據這些要求審查和批准您在 Marketplace 上的釋出。

以下是建立擴充套件時要遵循的簡單清單

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

建立與 Docker Desktop 一致的體驗

使用 Docker Material UI 主題Docker 擴充套件樣式指南,以確保您的擴充套件感覺是 Docker Desktop 的一部分,從而為使用者創造無縫體驗。

  • 確保擴充套件同時具有淺色和深色主題。根據 Docker 樣式指南使用元件和樣式可確保您的擴充套件符合 AA 級輔助功能標準

    Light and dark mode
  • 確保您的擴充套件圖示在淺色和深色模式下都可見。

    Icon colors in light and dark mode
  • 確保導航行為與 Docker Desktop 的其他部分一致。新增標題以設定擴充套件的上下文。

    Header that sets the context
  • 避免嵌入終端視窗。與 CLI 相比,Docker Desktop 的優勢在於我們可以向用戶提供豐富的資訊。儘可能多地利用此介面。

    Terminal window used incorrectly
    Terminal window used correctly

原生構建功能

  • 為了不中斷使用者流程,請避免使用者必須導航到 Docker Desktop 之外(例如 CLI 或網頁)才能執行某些功能的場景。相反,構建 Docker Desktop 原生功能。

    Incorrect way to switch context
    Correct way to switch context

分解複雜的使用者流程

  • 如果流程過於複雜或概念抽象,請將流程分解為多個步驟,每個步驟中只有一個簡單的操作呼籲。這有助於引導新手使用者使用您的擴充套件。

    A complicated flow
  • 在有多個操作呼籲的情況下,請確保使用主要(實心按鈕樣式)和次要按鈕(輪廓按鈕樣式)來傳達每個操作的重要性。

    Call to action

新使用者引導

建立擴充套件時,請確保擴充套件和您產品的首次使用者能夠理解其附加價值並輕鬆採用。確保在擴充套件中包含上下文幫助。

  • 確保將所有必要資訊新增到擴充套件 Marketplace 以及擴充套件詳情頁面。這應包括

    • 擴充套件的截圖。請注意,建議的截圖大小為 2400x1600 畫素。
    • 詳細的描述,涵蓋擴充套件的目的、哪些人會覺得它有用以及它如何工作。
    • 指向必要資源的連結,例如文件。
  • 如果您的擴充套件功能特別複雜,請在起始頁新增演示或影片。這有助於首次使用者快速上手。

    start page

下一步是什麼?