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

下一步是什么?