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

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 »