Docker 扩展的设计指南
目录
在 Docker,我们旨在构建能够融入用户现有工作流程的工具,而不是要求他们采用新的工作流程。我们强烈建议您在创建扩展时遵循这些指南。我们根据这些要求审查和批准您在 Marketplace 上的发布。
以下是创建扩展时要遵循的简单清单
- 是否易于上手?
- 是否易于使用?
- 需要时是否易于获得帮助?
创建与 Docker Desktop 一致的体验
使用 Docker Material UI 主题 和 Docker 扩展样式指南,以确保您的扩展感觉是 Docker Desktop 的一部分,从而为用户创造无缝体验。
确保扩展同时具有浅色和深色主题。根据 Docker 样式指南使用组件和样式可确保您的扩展符合 AA 级辅助功能标准。

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

确保导航行为与 Docker Desktop 的其他部分一致。添加标题以设置扩展的上下文。

避免嵌入终端窗口。与 CLI 相比,Docker Desktop 的优势在于我们可以向用户提供丰富的信息。尽可能多地利用此界面。


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


分解复杂的用户流程
如果流程过于复杂或概念抽象,请将流程分解为多个步骤,每个步骤中只有一个简单的操作呼吁。这有助于引导新手用户使用您的扩展。

在有多个操作呼吁的情况下,请确保使用主要(实心按钮样式)和次要按钮(轮廓按钮样式)来传达每个操作的重要性。

新用户引导
创建扩展时,请确保扩展和您产品的首次用户能够理解其附加价值并轻松采用。确保在扩展中包含上下文帮助。
确保将所有必要信息添加到扩展 Marketplace 以及扩展详情页面。这应包括
- 扩展的截图。请注意,建议的截图大小为 2400x1600 像素。
- 详细的描述,涵盖扩展的目的、哪些人会觉得它有用以及它如何工作。
- 指向必要资源的链接,例如文档。
如果您的扩展功能特别复杂,请在起始页添加演示或视频。这有助于首次用户快速上手。
