Docker 扩展的设计指南

在 Docker,我们的目标是构建能够集成到用户现有工作流程中的工具,而不是要求他们采用新的工作流程。我们强烈建议您在创建扩展时遵循这些指南。我们将根据这些要求审查和批准您的市场发布。

以下是在创建扩展时需要遵循的简单清单

  • 开始容易吗?
  • 使用方便吗?
  • 需要帮助时容易获得帮助吗?

与 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

引导新用户

创建扩展时,请确保第一次使用该扩展和产品的用户能够理解其附加值并轻松采用它。请确保在扩展中包含上下文帮助。

  • 请确保将所有必要信息添加到扩展市场以及扩展详情页面。这应包括:

    • 扩展的屏幕截图。请注意,建议的屏幕截图尺寸为2400x1600像素。
    • 详细说明扩展的用途、哪些用户会发现它有用以及它的工作原理。
    • 必要的资源链接,例如文档。
  • 如果您的扩展具有特别复杂的功能,请在起始页面添加演示或视频。这有助于快速引导第一次使用的用户。

    start page

下一步是什么?