Directives de conception pour les extensions Docker

Chez Docker, nous nous efforçons de créer des outils qui s'intègrent dans les flux de travail existants des utilisateurs plutôt que de les obliger à en adopter de nouveaux. Nous recommandons fortement de suivre ces directives lors de la création d'extensions. Nous examinons et approuvons votre publication sur le Marketplace en fonction de ces exigences.

Voici une liste de vérification simple à parcourir lors de la création de votre extension :

• Est-ce facile de commencer ?
• Est-ce facile à utiliser ?
• Est-ce facile d'obtenir de l'aide quand c'est nécessaire ?

Créer une expérience cohérente avec Docker Desktop

Utilisez le Docker Material UI Theme et le Guide de style des Extensions Docker pour vous assurer que votre extension donne l'impression de faire partie de Docker Desktop et créer une expérience transparente pour les utilisateurs.

• Assurez-vous que l'extension dispose d'un thème clair et d'un thème sombre. L'utilisation des composants et styles selon le guide de style Docker garantit que votre extension respecte le standard d'accessibilité de niveau AA..

  

• Assurez-vous que l'icône de votre extension est visible à la fois en mode clair et sombre.

  

• Assurez-vous que le comportement de navigation est cohérent avec le reste de Docker Desktop. Ajoutez un en-tête pour définir le contexte de l'extension.

  

• Évitez d'intégrer des fenêtres de terminal. L'avantage que nous avons avec Docker Desktop par rapport à l'interface en ligne de commande est que nous avons l'opportunité de fournir des informations riches aux utilisateurs. Tirez parti de cette interface autant que possible.

  

  

Créer des fonctionnalités nativement

• Pour ne pas perturber le flux des utilisateurs, évitez les scénarios où l'utilisateur doit naviguer en dehors de Docker Desktop, vers l'interface en ligne de commande ou une page web par exemple, pour effectuer certaines fonctionnalités. Créez plutôt des fonctionnalités natives à Docker Desktop.

  

  

Décomposer les flux utilisateur compliqués

• Si un flux est trop compliqué ou si le concept est abstrait, décomposez le flux en plusieurs étapes avec un seul appel à l'action simple dans chaque étape. Cela aide lors de l'intégration d'utilisateurs novices à votre extension

  

• Lorsqu'il y a plusieurs appels à l'action, assurez-vous d'utiliser les boutons primaires (style de bouton rempli) et secondaires (style de bouton en contour) pour transmettre l'importance de chaque action.

  

Intégrer de nouveaux utilisateurs

Lors de la création de votre extension, assurez-vous que les utilisateurs de première fois de l'extension et de votre produit peuvent comprendre sa valeur ajoutée et l'adopter facilement. Assurez-vous d'inclure une aide contextuelle dans l'extension.

• Assurez-vous que toutes les informations nécessaires sont ajoutées au Marketplace des extensions ainsi qu'à la page de détails de l'extension. Cela devrait inclure :

  • Des captures d'écran de l'extension. Notez que la taille recommandée pour les captures d'écran est de 2400x1600 pixels.
  • Une description détaillée qui couvre quel est le but de l'extension, qui la trouverait utile et comment elle fonctionne.
  • Un lien vers les ressources nécessaires telles que la documentation.

• Si votre extension a une fonctionnalité particulièrement complexe, ajoutez une démo ou une vidéo à la page de démarrage. Cela aide à intégrer rapidement un utilisateur de première fois.

  

Et maintenant ?

• Explorez nos principes de conception.
• Consultez nos directives de style UI.
• Apprenez comment publier votre extension.