Docker 扩展的设计指南

在 Docker,我们的目标是构建能够集成到用户现有工作流程中的工具,而不是要求他们采用新的工作流程。我们强烈建议您在创建扩展时遵循这些准则。我们根据这些要求审核并批准您的 Marketplace 出版物。

这是创建扩展程序时需要执行的简单清单:

  • 容易上手吗?
  • 这个容易用吗?
  • 需要时是否容易获得帮助?

使用 Docker Desktop 创建一致的体验

使用 Docker Material UI 主题Docker 扩展样式指南,确保您的扩展感觉像是 Docker Desktop 的一部分,从而为用户创建无缝体验。

  • 确保扩展程序具有浅色和深色主题。根据 Docker 样式指南使用组件和样式可确保您的扩展符合 AA 级可访问性标准。

    浅色和深色模式
  • 确保您的扩展程序图标在浅色和深色模式下都可见。

    浅色和深色模式下的图标颜色
  • 确保导航行为与 Docker Desktop 的其余部分一致。添加标头以设置扩展的上下文。

    设置上下文的标头
  • 避免嵌入终端窗口。与 CLI 相比,Docker Desktop 的优势在于我们有机会向用户提供丰富的信息。尽可能利用这个接口。

    终端窗口使用不正确
    正确使用终端窗口

本地构建功能

  • 为了不中断用户流程,请避免用户必须导航到 Docker Desktop 外部(例如 CLI 或网页)才能执行某些功能的情况。相反,构建 Docker Desktop 的原生功能。

    切换上下文的方式不正确
    切换上下文的正确方法

分解复杂的用户流程

  • 如果流程过于复杂或概念过于抽象,请将流程分解为多个步骤,并在每个步骤中添加一个简单的号召性用语。这有助于新手用户使用您的分机

    复杂的流程
  • 如果有多个号召性用语,请确保使用主要(填充按钮样式)和辅助按钮(轮廓按钮样式)来传达每个操作的重要性。

    呼吁采取行动

入职新用户

创建扩展程序时,请确保该扩展程序和您的产品的首次用户可以了解其增值并轻松采用。确保您在扩展中包含上下文帮助。

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

    • 扩展程序的屏幕截图。请注意,建议的屏幕截图尺寸为 2400x1600 像素。
    • 详细描述,涵盖扩展程序的用途、谁会发现它有用以及它如何工作。
    • 链接到必要的资源,例如文档。
  • 如果您的扩展程序具有特别复杂的功能,请将演示或视频添加到起始页。这有助于首次用户快速入门。

    首页

下一步是什么?