Présentation du mode simple pour les catégories de documentation Discourse

[saquetim (Sérgio Saquetim)]

Les catégories de documentation sont conçues pour un type de contenu spécifique : des matériaux de référence auxquels les lecteurs reviennent, qu’ils consultent rapidement et vers lesquels ils lient souvent. Pour soutenir cela, nous introduisons un nouveau mode simple pour le plugin Discourse Doc Categories, qui offre à la documentation une expérience centrée sur la lecture tout en maintenant le sujet complet accessible en un clic.

Une vue de sujet axée sur la lecture

Lorsque le mode simple est activé, l’ouverture d’un sujet de documentation met le document lui-même au premier plan. Les réponses restent à un clic, derrière un bouton bascule dans le premier message (OP) :

Afficher 12 commentaires / Masquer les commentaires

Cliquez dessus et la discussion complète apparaît à sa place habituelle, triée et rendue exactement comme toujours. Cliquez à nouveau pour la réduire.

Quelques détails worth mentionner :

• Un lien direct vers une réponse (/t/slug/id/4) ouvre automatiquement le sujet, de sorte que toute personne arrivant via un lien partagé ou une notification atterrit sur le message qui lui a été envoyé.
• Les nouvelles réponses qui arrivent pendant que le sujet est réduit sont comptabilisées dans l’étiquette du bouton bascule, vous permettant de voir d’un coup d’œil quand quelque chose de nouveau est arrivé.

Une liste de sujets adaptée à la documentation

Dans une catégorie de documentation, la liste des sujets est également simplifiée : les colonnes se concentrent sur le titre et la date de la dernière mise à jour, la colonne Activity étant libellée Mis à jour. Les lecteurs peuvent parcourir les titres et repérer d’un coup d’œil ce qui est récent.

Le résultat ressemble davantage à une base de connaissances : une liste épurée d’articles, chacun accessible en un clic.

Activez-le sur votre site

Le mode simple est livré en tant que changement à venir expérimental. Rendez-vous sur la page des changements à venir dans votre zone d’administration (/admin/config/upcoming-changes) et cherchez Mode simple des catégories de documentation pour vous inscrire.

Ce changement ne s’applique qu’aux sujets situés dans des catégories configurées comme catégories de documentation, le reste de votre site restant inchangé.

Nous aimerions avoir votre avis

Le mode simple est encore à ses débuts et nous prévoyons de continuer à l’améliorer. Si vous l’activez pour vos documents, veuillez partager ce qui fonctionne, ce qui manque et les problèmes rencontrés. Vos retours façonneront la suite de ce projet.

[Jonathan5]

Cela semble bien. J’ai récemment posé une question dans un sujet de la catégorie « Docs » avant de réaliser qu’il y avait déjà des publications (Backup discourse from the command line - #37 by Jonathan5), mais ce n’est pas la fin du monde !

[Moin]

J’ai partagé des retours ici, car ce sujet n’existait pas à l’époque. Il est probablement inutile de faire un lien vers cela ici, mais jusqu’à présent, personne n’y a répondu.

[Moin]

Les étiquettes chevauchent le nombre de modifications et la date de publication du sujet :

En mode sans échec, qui désactive la modification des sujets de catégorie de document, le nombre de modifications, la date et les étiquettes sont tous lisibles :

[Moin]

J’ai créé la première réponse sur un sujet dans une catégorie de document. Il m’a semblé un peu confus que ma réponse ne soit pas visible après l’avoir publiée. Je pense qu’après avoir publié la réponse, les commentaires devraient être automatiquement démasqués.

[Moin]

Il semble que ce problème ait été corrigé

[Moin]

Aujourd’hui, j’ai remarqué que je manquais vraiment de voir les informations de sous-catégorie en consultant Documentation

Parfois, je ne suis pas sûr dans quelle catégorie se trouve le sujet, donc je ne visite pas une sous-catégorie spécifique. Mais bien sûr, j’ai une idée des catégories dans lesquelles je m’attends à le trouver, et de celles où ce n’est pas le cas.
Les sous-catégories séparent également clairement le public cible - par exemple Documentation > Hosted Customers et Documentation > Self-Hosting ou Documentation > Site Management et Documentation > Using Discourse. Cette information est absente lorsque la catégorie est masquée, ce qui rend plus difficile la décision de savoir si ce guide pourrait être adapté à vos besoins.