Documentation de restructuration pour une meilleure clarté

:white_check_mark: Mise à jour (4 juin 2024) : Les travaux initiaux de restructuration des sujets de documentation sont terminés, et les nouvelles catégories sont désormais en ligne avec de nouveaux index indiquant ce que vous y trouverez. Vous pouvez les consulter ici : Documentation - Discourse Meta - si vous remarquez quoi que ce soit d’incorrect, veuillez poster ci-dessous !

Après un examen approfondi de notre structure de documentation actuelle, nous sommes heureux de partager que nous sommes en train d’améliorer la catégorisation de notre documentation afin de rendre les sujets plus organisés et axés sur les objectifs que notre communauté vise à atteindre. Notre objectif est d’améliorer la clarté et la convivialité de notre documentation, afin que chacun puisse trouver plus facilement les informations dont il a besoin.

Ce à quoi il faut s’attendre

:label: Nouvelles catégories

À l’avenir, notre documentation sera catégorisée et étiquetée en fonction de l’action ou de la fonctionnalité qu’elle décrit. Les regroupements actuels basés sur le rôle de l’utilisateur disparaîtront, et nous mettrons à jour tous les sujets de documentation pour indiquer quel rôle d’utilisateur est requis pour effectuer les activités qu’ils décrivent.

:eyes: Changements visuels temporaires

Pendant cette restructuration, vous pourriez remarquer que certaines sections de notre documentation semblent un peu déplacées ou désorganisées. Ne vous inquiétez pas ! Ce n’est que temporaire pendant que nous finalisons la nouvelle structure.

:white_check_mark: Mises à jour complètes

Une fois la restructuration terminée, notre prochaine étape sera de mettre à jour tous les sujets de documentation pour les aligner sur un nouveau guide de style commun. Nous corrigerons également toutes les inexactitudes qui pourraient exister. Il s’agira d’un projet continu, dont la majeure partie sera réalisée au cours des prochaines semaines.

Comment vous pouvez aider

Vos commentaires, comme toujours, nous sont précieux. Si vous rencontrez des problèmes ou si vous avez des suggestions sur la façon dont nous pouvons améliorer davantage notre documentation, n’hésitez pas à partager vos réflexions dans Site feedback ou en postant sur ce sujet.

Merci de votre patience pendant que nous apportons ces changements !

14 « J'aime »

Les sujets concernant la modération, comme Discourse Moderation Guide, font partie de Documentation > Site Management. Peut-être que cela devrait être ajouté à la description car, en tant que modérateur, je ne regarderais pas les sujets d’une catégorie destinée aux « propriétaires et administrateurs de site ».

3 « J'aime »

J’ai apporté une petite modification au texte de la section « À propos » pour indiquer qu’il est également utile pour les modérateurs.

@JammyDodger et/ou @hugh pourraient avoir des réflexions supplémentaires lorsqu’ils verront cela plus tard également.

2 « J'aime »

Je lui ai apporté une touche supplémentaire :

4 « J'aime »

Merci de l’avoir signalé @Moin !

@JammyDodger Votre mise à jour me semble bonne.

Le travail initial de restructuration des sujets de documentation est terminé, et les nouvelles catégories sont maintenant en ligne avec de nouveaux index indiquant ce que vous y trouverez.

Vous pouvez les consulter ici : Documentation - Discourse Meta - si vous remarquez quelque chose d’incorrect, veuillez poster ci-dessous !

1 « J'aime »

Envisagez-vous d’ajouter les nouvelles catégories au plugin de documentation ?

1 « J'aime »

Nous hésitons entre essayer la vie sans le plugin de documentation ou non. :slight_smile: Pour l’instant, j’ai ajouté les nouvelles catégories au mélange. :+1:

3 « J'aime »

Une publication a été fusionnée dans un sujet existant : Meilleure navigation dans la documentation avec une nouvelle barre latérale

Puis-je savoir comment le texte des liens vers les sujets dans la barre latérale lorsqu’on est dans une sous-catégorie est créé ? IA ?

1 « J'aime »

Chaque sous-catégorie a un sujet d’index, par exemple : Using Discourse Index (ceux-ci sont liés à partir de la description dans l’en-tête de chaque sous-catégorie).

La barre latérale utilise les titres abrégés de là pour les utiliser à la place des titres complets des articles.

3 « J'aime »