Inclure plus d'indices tout au long de Discourse qui renvoient aux documents pertinents sur Meta

Contexte

L’équipe de Discourse a mentionné à plusieurs endroits qu’elle cherchait à améliorer l’expérience d’administration.

Problème

Il existe de nombreux paramètres dans Discourse et une abondance de documentation. Mais il est peu probable que vous trouviez la bonne documentation au bon moment.

Fonctionnalité

Il pourrait y avoir beaucoup plus d’endroits dans les paramètres et les menus de Discourse où la documentation correspondante sur \u003chttps://meta.discourse.org/docs\u003e est liée.

Par exemple, il y a l’article de blog Understanding Discourse Trust Levels qui est lié dans les installations de Discourse.

Mais il y en a beaucoup d’autres qui ne le sont pas.

Par exemple, il y a un guide sur la suppression d’une catégorie.

Il semble que cela serait pertinent/utile à inclure dans la fenêtre modale où vous pouvez voir le bouton pour supprimer des catégories.

Cela pourrait être un lien, mais pas nécessairement juste un lien pour chaque cas – cela pourrait être un bouton point d’interrogation qui renvoie à la documentation, ou cela pourrait être “En savoir plus…” etc.

L’équipe de Discourse pourrait parcourir la documentation, en commençant par les éléments principaux, et déterminer où, dans le logiciel, serait l’endroit le plus pertinent pour lier cette documentation.

(Aka “juste à temps”)

Autres exemples de logiciels

Ghost (un logiciel de blogging open source) a quelques endroits où sa documentation est liée, juste au moment où vous en avez besoin.

Par exemple, ce bouton “En savoir plus” renvoie à la documentation pertinente :

Il en va de même ici :

Je n’étais pas sûr si cela correspondait à Feature ou UX, n’hésitez pas à le déplacer.

5 « J'aime »

Je ne suis pas tout à fait d’accord. Il existe différentes portées de contenu d’aide que vous pouvez créer. Si l’on suit le modèle Diátaxis, il s’agit de tutoriels, de guides pratiques, de références et d’explications.

Les tutoriels ont probablement leur place dans l’application elle-même, de sorte que si vous arrivez sur une page avec l’intention de « vouloir apprendre comment cela fonctionne », vous pouvez l’apprendre, même si la page n’est pas explicite. Peut-être même un centre de tutoriels qui vous permet de suivre un cours sur le logiciel si vous le souhaitez.

Les trois autres catégories posent problème.

Si je vais sur la page des paramètres de catégorie, il peut y avoir 20 choses différentes que je veux faire. Mettre un guide pratique là-bas entraînerait une liste que je devrais rechercher - et parce que j’ai l’impression que ce que je cherche n’aura pas nécessairement un article dédié, je taperai probablement cette question dans Google plutôt que de chercher dans la liste.

Les références externes sont un fléau auquel je suis confronté quotidiennement. Nous avons un « manuel de référence » qui vous indique ce que fait chaque curseur et bouton, jusqu’à :

Bouton Annuler : Ferme la boîte de dialogue sans appliquer les modifications
Bouton OK : Ferme la boîte de dialogue, en appliquant les modifications

Utiliser cette référence signifie que vous devez faire défiler beaucoup de choses techniques avant d’arriver à votre section, alors que ce dont vous aviez vraiment besoin est une info-bulle qui reformule une option en quelques mots supplémentaires.

Si j’essaie de supprimer une catégorie, le comportement actuel est presque souhaitable. Je vois le bouton, généralement grisé mais avec un point d’interrogation, et si je clique dessus, il dit :

Impossible de supprimer cette catégorie car elle contient des sous-catégories.

ou :

Impossible de supprimer cette catégorie car elle contient 25852 sujets. Le sujet le plus ancien est…

Le comportement est bon, je sais ce qui ne va pas et quelle est ma prochaine étape - supprimer un tas de messages et de sous-catégories. Cela ne serait pas amélioré en renvoyant au guide pratique « supprimer une catégorie » à la place.

Bien sûr, cela reste un pansement sur le vrai problème : Pourquoi ne puis-je pas supprimer une catégorie avec des messages ? Je peux supprimer des dossiers avec des sous-dossiers et des fichiers sur mon système, pourquoi ne puis-je pas supprimer des catégories avec des sous-catégories et des messages ? Si elle n’avait pas ces restrictions étranges, il n’y aurait pas besoin d’un guide pratique dans l’application en premier lieu.

Et enfin, les explications - c’est ce qu’est l’article de blog « comprendre les niveaux de confiance ». Lorsque je l’ai rencontré pour la première fois, c’était assez déroutant - « un article de blog aléatoire vieux de 6 ans est-il vraiment le meilleur que vous ayez comme documentation ? » - et il renvoie à un article de référence qui liste toutes les choses dans un tableau, ce qui correspondait davantage à ce que j’attendais (bien que pas trié comme je m’y attendais). Les explications ne m’aident pas à accomplir une tâche directement, donc les placer là où une tâche serait accomplie ne fonctionne pas très bien.


Je pense qu’en fin de compte, bien que la documentation soit importante dans certains endroits (par exemple, l’intégration, ou dans des cas où la conception échoue), c’est vraiment la conception qui devrait être la priorité. Lire ou regarder une vidéo dans laquelle quelqu’un vous explique le site web est rarement l’expérience souhaitée.

5 « J'aime »

Oui, en tant qu’ancien étudiant en conception de jeux, je suis entièrement d’accord avec vous. (Je me souviens que vous êtes le concepteur d’Audacity. D’ailleurs, j’utilise beaucoup Audacity, j’en suis très reconnaissant !)

Je pense aussi que toute l’expérience pourrait être repensée à partir de zéro (en commençant par se demander : « Que voudrait faire un administrateur, et comment pouvons-nous l’aider au mieux à le faire ? » pour tous les cas d’utilisation) afin que les processus soient mieux transmis et que les processus eux-mêmes soient aussi simples que possible.

Pour l’exemple de ne pas vous permettre de supprimer une catégorie s’il y a des sujets dedans, une manière plus élégante pour le logiciel de gérer cela pourrait être la suivante. Lorsque vous essayez de supprimer une catégorie contenant des sujets, il pourrait d’abord vous suggérer si vous souhaitez :

  • déplacer tous les sujets existants vers une autre catégorie, ou
  • placer tous les sujets existants dans “Non catégorisé”, ou
  • supprimer tous les sujets de la catégorie

puis confirmer que vous souhaitez supprimer la catégorie.

Je suppose qu’en voyant que l’équipe Discourse visait des changements plus progressifs à ce stade :

J’ai plaidé pour une solution plus facile à mettre en œuvre – ajouter des liens vers la documentation la plus populaire/courante/importante là où ce serait le plus pertinent.

(Je créerai peut-être aussi un nouveau sujet plus tard pour les commentaires/suggestions dont nous avons parlé ici, sur l’amélioration de l’expérience de suppression des catégories.)

J’aime beaucoup cette suggestion - merci de l’avoir mise en avant, @bloomexperiment ! Nous travaillons actuellement à l’amélioration de la structure générale et de la catégorisation de notre documentation, et je pense que ce type de fonctionnalité mériterait d’être pris en compte dans ce processus. Je l’ajouterai à la feuille de route de la documentation comme quelque chose à explorer, et nous verrons comment elle pourrait être mise en œuvre au mieux.

2 « J'aime »

Désolé de déterrer un vieux sujet, et très conscient du travail actuel autour de la recherche d’administration et de l’amélioration de l’expérience d’administration globale. Ces dernières semaines, j’ai souvent pensé à quel point j’aimerais que le nom de chaque paramètre de site soit un lien vers le sujet de documentation pertinent sur Meta. Au cours des dernières années, la documentation Meta s’est considérablement améliorée, et est maintenant assez complète, organisée et informative.

Exemple :

Dans l’exemple ci-dessus, j’aimerais que « Emplacement de sauvegarde » renvoie à un sujet Meta tel que Configure automatic backups for Discourse

Pourrions-nous progressivement atteindre un stade où chacun de ces noms de paramètres de site renverrait au fil Meta pertinent ? Je peux comprendre que vous ne souhaitiez pas coder en dur des URL dans le code de Discourse, mais je suppose que cela pourrait se trouver d’une manière ou d’une autre dans les textes du site.

Le travail de création de tous ces liens est assez important, mais peut-être qu’un effort collaboratif de la part d’un certain nombre d’auto-hébergeurs serait possible ?

3 « J'aime »