Aller au contenu

Skills

do-not-ship-an-empty-surface

Un écran, un onglet ou une catégorie vide est une promesse que le produit ne tient pas. Masquez-le jusqu'à ce qu'il ait du contenu, ou ne le construisez pas encore.

Anti-patronProvenance: cleanStatut: activev0.1.0 · Apache-2.0

Conférée par la personne qui a relu la fiche, et non revendiquée par le fichier lui-même. Une fiche que l'agent distille au cours d'une exécution ayant consommé du contenu non fiable naît contaminée et reste en attente de relecture avant d'être un jour récupérée.

Quand elle vient à l'esprit

  • ajouter un onglet sans données
  • la catégorie n'a aucun article
  • écran provisoire
  • bientôt disponible

C'est dans À éviter et Vérifier que se trouve d'ordinaire la valeur. À faire est la section que tout le monde écrit.

Le corps de la fiche ci-dessus est une traduction. L'original anglais est ce que la CLI importe, ce que l'agent lit à l'exécution et ce que l'empreinte ci-dessous atteste.

Déclencheur

Vous vous apprêtez à livrer une destination navigable qui sera vide pour la plupart des utilisateurs : un onglet sans lignes, une catégorie sans entrées, un tableau de bord dont la source de données n'est pas branchée, une page qui dit « bientôt disponible ».

Cela ne s'applique pas à une surface vide parce que l'utilisateur n'a encore rien fait. Une liste de tâches sans tâche est correcte, et doit indiquer comment en ajouter une.

À faire

  1. Déterminez de quel type de vide il s'agit. Vide-parce-que-l'utilisateur-est-nouveau a besoin d'un bon état vide avec la prochaine action dedans. Vide-parce-que-nous-ne-l'avons-pas-encore-construit ne doit tout simplement pas exister.
  2. Pour le second type : ne rendez pas du tout la destination. Ne générez la route que lorsqu'il y a quelque chose derrière.
  3. Si elle doit exister pour le développement, conditionnez-la à un flag de développement pour qu'un build installé ne puisse pas l'atteindre.
  4. Là où le vide est vraiment la nouveauté en soi — un hub avec une seule entrée, un flux qui vient de démarrer — dites-le en toutes lettres, et faites de l'invitation à contribuer le contenu principal de la page.

À éviter

« Bientôt disponible », « Pas encore de données » sans explication, et une entrée de navigation qui mène à une colonne vide. Chacune coûte un clic au lecteur pour ne rien lui rendre, et après deux d'entre elles il cesse de faire confiance à la navigation — un coût payé par toutes les autres pages du produit.

Évitez aussi la version qui a l'air correcte : une page de catégorie qui se rend correctement avec zéro élément. Elle n'a pas l'air cassée, donc personne ne la signale, et elle dit discrètement que le projet a abandonné ce sujet.

Vérifier

Chargez la surface avec une source de données vide et lisez ce qu'un utilisateur venant pour la première fois verrait. Si la réponse est un titre et du vide, elle n'aurait pas dû être livrée.

Pour les routes générées, la vérification est mécanique : vérifiez que la liste des routes est dérivée du contenu, de sorte qu'une catégorie sans entrées ne produise aucune page du tout.

Risque

Masquer une destination jusqu'à ce qu'elle ait du contenu fait bouger la navigation à mesure que les données arrivent, ce qui peut être déroutant — un menu qui grossit entre deux visites a besoin d'une raison que l'utilisateur puisse déduire.

Cela peut aussi être poussé trop loin, jusqu'à masquer des fonctionnalités simplement peu utilisées. La ligne de démarcation est de savoir si la surface peut un jour montrer quelque chose : ce qui n'est pas construit est masqué, ce qui est peu utilisé est montré avec un bon état vide.

L'utiliser

La fiche est une donnée. Clonez le dépôt et importez-la par son chemin — ce qui arrive par le réseau est traité comme contaminé et retenu pour approbation, ce qui est le comportement souhaitable et la raison pour laquelle il n'y a pas d'installateur en une ligne ici.

git clone https://github.com/brcampidelli/chimera-agent.git
chimera skills-import chimera-agent/skills/do-not-ship-an-empty-surface/SKILL.md

Intégrité

SHA-256 du fichier tel qu'il est publié. Qui l'importe peut vérifier que ce qu'il a reçu correspond à ce que cette page affichait.

c4dbc6291edf3d41c3820bea6ed19cd283dd90e75d41d61dad97bdab972b7965

Lire la fiche dans le dépôt