Nouveau plugin de documentation en développement

Annonces
,
1

Nous avons récemment mis à disposition notre nouveau plugin de documentation pour des tests et des retours. Ce plugin est conçu pour améliorer la navigation et l’accessibilité de la documentation hébergée sur Discourse, offrant une expérience plus accessible et conviviale à tous les utilisateurs. Notez que ce plugin est encore en développement.

Le développement de ce plugin découle de notre effort continu pour améliorer la documentation, qui a déjà été amélioré par une nouvelle barre latérale. Le travail sur la barre latérale a jeté les bases d’une expérience de documentation beaucoup plus améliorée, et le nouveau plugin s’appuie progressivement sur ce travail.

:boom: Le nouveau plugin en action

Le plugin est actuellement actif et alimente la documentation sur notre documentation officielle Discourse. Nous vous invitons à explorer ses fonctionnalités et à partager vos expériences avec nous. Vos commentaires sont précieux pour nous aider à affiner et à améliorer le plugin.

Les fonctionnalités principales incluses dans le nouveau plugin sont :

  • Paramètres pour définir les catégories utilisées pour la documentation
  • Une nouvelle barre latérale de documentation peuplée par des sujets d’index dans chaque catégorie
  • Deux nouveaux rapports pour aider à maintenir l’intégrité et l’exactitude des sujets d’index

Avec plus de fonctionnalités en développement, car nous améliorons continuellement les fonctionnalités disponibles.

Le nouveau plugin est disponible en téléchargement et en installation dès aujourd’hui : Discourse Doc Categories

:electric_plug: Transition depuis le plugin Discourse Docs

Alors que nous innovons et avançons, nous allons abandonner notre ancien plugin Discourse Docs. Vous pouvez être assuré, cependant, que nous continuerons à le supporter jusqu’à ce que le nouveau plugin soit entièrement prêt pour une diffusion à grande échelle. Nous avons également veillé à ce que le nouveau plugin redirige les URL de l’ancien plugin, de sorte que le passage ne résultera en aucun lien brisé.

Veuillez noter que le nouveau plugin est encore à ses stades expérimentaux. Bien que nous visons à offrir une expérience transparente, il peut y avoir certains domaines qui nécessitent une amélioration supplémentaire. Vos commentaires constructifs seront cruciaux pour son succès.

:speaking_head: Dites-nous ce que vous en pensez

Nous apprécierions vos réflexions, expériences et commentaires. N’hésitez pas à partager vos expériences et les informations que vous recueillez en utilisant le nouveau plugin de documentation, soit en naviguant dans la documentation sur Meta, soit en installant le plugin sur votre propre site.

Notre objectif est de façonner une meilleure expérience de documentation pour toute la communauté Discourse, donc tous les commentaires sont les bienvenus !

Détails complets du plugin disponibles ici :

13 « J'aime »
2

Quelqu’un doit mettre à jour le readme. Et peut-être mettre à jour les règles de lint pour éviter que cela ne se produise, bien qu’il y ait un problème d’œuf/poule.

Il semble que cela pourrait également être idéal pour utiliser Discourse comme un LMS. Pour cela, il serait bon de pouvoir changer quelle catégorie était une catégorie de documentation, bien qu’il y ait une bonne chance que le simple fait d’utiliser les permissions pour donner aux utilisateurs l’accès à certaines catégories suffise pour que cela fonctionne.

8 « J'aime »
3

Bonne prise de l’URL - Je viens de soumettre une PR pour l’ajouter.

Cela ressemble à un cas d’utilisation intéressant pour cela, et je peux voir comment cela fonctionnerait très bien !

6 « J'aime »
4

C’est une amélioration fantastique par rapport au plugin original Docs/base de connaissances. Jusqu’à présent, cela semble très convivial.

Tester sur Meta est certainement un énorme avantage, car les catégories de documentation peuvent être difficiles à trouver auparavant.

5 « J'aime »
5

Oserais-je demander une ETA ? C’est-à-dire quand ce plugin sera-t-il considéré comme moins expérimental et plus en phase bêta, ou peut-être même en phase de candidat à la sortie anticipée ? Je sais combien il est difficile de prédire l’avenir, donc je me contenterai de toute estimation approximative, aussi inexacte soit-elle. :wink:

J’explore actuellement Discourse comme outil au travail, précisément parce qu’il semble pouvoir offrir un bon mélange de discussions communautaires et un espace partagé pour la documentation. Où il est aussi facile d’écrire de la documentation que de poster un commentaire sur un sujet.

Ainsi, la fonctionnalité de sujet wiki en soi est bien sûr intéressante, c’est un excellent début. Ce plugin, cependant, ajoute de la cohésion au contenu des sujets, ce qui, je crois, est essentiel pour l’expérience utilisateur de la documentation.

La catégorie Documentation sur meta.discourse.org ressemble maintenant à un véritable site de documentation structuré, plutôt que de simples sujets de forum aléatoires qui partagent une catégorie et décrivent le fonctionnement de Discourse.

Alors, continuez votre bon travail. Merci !

1 « J'aime »
7

J’adore ça ! La documentation et les discussions s’emboîtent très bien.

Avez-vous l’intention d’activer l’indexation des balises en plus des catégories ?

8

Je pense que le stade dans lequel nous nous trouvons actuellement est « la beauté (ou son absence) est dans l’œil de celui qui regarde ».

Il est expérimental dans le sens où il existe des problèmes d’UX connus, en particulier pour les personnes responsables de la maintenance de la documentation et surtout des index, mais il est tout à fait sûr à utiliser en production.

Tout cela pour dire que nous serions très heureux de recevoir vos commentaires si vous l’essayez et que vous le testez vous-même.

Nous n’avons pas d’ETA pour le moment pour améliorer les problèmes d’UX connus avec la maintenance des index, mais les commentaires des personnes qui l’utilisent pourraient aider à orienter la direction.

Non, ce n’est pas quelque chose qui est apparu ailleurs pour le moment. Pouvez-vous partager un peu plus ce que vous avez en tête ou pourquoi cela vous serait utile ?

4 « J'aime »
9

À propos de ceci : si vous êtes dans une catégorie de document et que vous fermez une fenêtre de chat non plein écran, la navigation du document est également « fermée » et la barre de navigation normale s’affiche à nouveau. Tout en reproduisant sur meta, j’ai également remarqué qu’en cliquant sur la bulle de chat (en haut à droite de l’en-tête), cela ferme également la navigation du document. J’espère que cela vous aidera !

3 « J'aime »
11

Merci d’avoir signalé cela - je suis en mesure de reproduire le problème, je l’ai donc signalé et nous l’inclurons dans les prochains travaux de développement.

3 « J'aime »
13

Cela me rappelle une chose concernant Discourse en tant que projet, qui n’est pas vraiment idéale pour moi en tant qu’utilisateur. Le fait que le projet n’utilise pas un véritable suivi public des problèmes pour les bogues et la planification.

Par exemple, quand je lis la réponse de Hugh, mon chef de projet interne a immédiatement soulevé la question : où, où cela a-t-il été enregistré ?. Je sais, mon chef de projet interne est une petite créature curieuse, n’est-ce pas ? :slight_smile:

Je suppose qu’utiliser meta.discourse.org comme suivi des problèmes donne au projet une opportunité de “dogfooding” Discourse. Et tous les autres suivis des problèmes ont leurs propres défauts, donc c’est une corvée de devoir en choisir un. Mais pour moi, Discourse - tout en étant excellent en tant que forum pour les questions et les discussions - est très limité en tant que suivi des problèmes. À cette fin, il manque une catégorisation efficace, des informations sur les versions affectées et cibles, des numéros de problème, une priorisation, des moyens efficaces de filtrer les problèmes par statut, âge, priorité, produit ou composant, et une bonne façon de présenter une feuille de route pour une fonctionnalité ou le produit dans son ensemble, entre autres choses.

Bon, je digresse. Et je n’ai pas encore contribué une seule ligne de code, rapport de bogue ou demande de fonctionnalité, alors qui suis-je pour me plaindre. :wink:

Donc, encore une fois, merci à tous pour l’extraordinaire Discourse. Et pardonnez ce semi-coup de gueule.

Et pour en revenir au sujet, c’est formidable d’apprendre que les catégories de documentation de Discourse, bien que pas encore parfaites, sont considérées comme architecturalement stables. Je vais voir si je peux l’installer sur mon instance Discourse hébergée, et si c’est le cas, j’essaierai de revenir avec des commentaires. Merci !

6 « J'aime »
14

J’ai oublié de répondre ici. Merci pour votre suivi.

Je comprends que #wiki pourrait s’intégrer dans différentes catégories comme community support dev, et il est préférable de montrer des données basées sur les centres d’intérêt des utilisateurs.

Pendant ce temps, montrer ces wikis organisés dans les docs (lien dans la barre latérale du wiki) semble magnifique.

1 « J'aime »
15

Nous utilisons Discourse comme outil de suivi des problèmes. Mieux dit – j’essaie de forcer mon équipe à utiliser Discourse comme outil de suivi des problèmes :slight_smile: Et un wiki, et un forum, et de la documentation… Je soupçonne l’équipe CDCK d’avoir un autre site Discourse « secret » où ils suivent leurs affaires en interne, en utilisant des plugins intéressants, que personne n’a…

Peu importe la qualité de l’outil de suivi des problèmes ici, la communauté ne peut être comparée à rien d’autre que je connaisse. En fin de compte, ce sont les gens qui développent le logiciel, pas la technologie derrière. Et ils sont géniaux ! :metal:

Et j’aime beaucoup le plugin de documentation. :heart:

Maintenant, avec tous mes éloges, serait-il possible d’approuver ma PR ? :smiley:

5 « J'aime »
16

As-tu vu la réponse de Gerhard sur ce PR ?

3 « J'aime »
17

Nous avons un autre site que nous utilisons en interne et c’est effectivement ainsi que nous suivons une grande partie de notre travail. Mais nous ne le faisons pas avec des plug-ins secrets.

Principalement, nous utilisons des conventions, comme une catégorie pour les « todos » et un ensemble standard de quelques balises pour une sorte de priorisation maintenant/ensuite/plus tard, ainsi que le plug-in d’assignation pour clarifier la propriété.

Cela permet également au composant thématique kanban de fonctionner, mais tout le monde n’utilise pas cette vue.

C’est assez fluide, pas un traqueur de problèmes très dogmatique, mais cela fonctionne bien pour nous.

Je pourrais partager plus de détails un jour…

6 « J'aime »
18

Non ! C’est de ma faute. Corrigé. Merci pour le signalement.

3 « J'aime »