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

接下来是什么?