Récemment, nous nous sommes efforcés d’améliorer notre documentation ici sur meta, en nous concentrant sur la catégorisation des éléments de telle sorte que différents utilisateurs puissent trouver des sujets qui leur sont pertinents et ignorer ceux qui ne le sont pas.
Nous visons à ce que toute la documentation soit classée dans l’une des catégories suivantes :
- #documentation:users - usage général courant
- #documentation:moderators - modération d’une communauté
- #documentation:theme-developers - développement de thèmes et de composants de thèmes
- #documentation:admins - administration d’un site Discourse
- #documentation:devs - développement de fonctionnalités, plugins et intégrations Discourse
- #documentation:sysadmin - administration système auto-hébergée
Nous prévoyons de supprimer #documentation:faq et #documentation:tips-and-tricks à la fin de cette période (mais nous avons commencé à étiqueter certains sujets dans les nouvelles catégories avec #tips-and-tricks).
Nous visons également à étiqueter la documentation avec l’une de ces balises de classification empruntées à divio, conformément à ce message précédent :
Les choses ne s’ajustent pas toujours parfaitement. Dans certains cas, nous divisons les sujets, et dans d’autres, nous utilisons simplement la balise ou la catégorie qui convient le mieux dans son état actuel.
Quelques changements courants que nous avons apportés aux sujets individuels jusqu’à présent (nous sommes maintenant environ à 50% du travail).
- Déplacement d’éléments de #documentation:admins vers #documentation:sysadmin lorsqu’ils nécessitent un accès console.
- Division des sujets de #documentation:faq en sujets pour #documentation:admins et sujets pour #documentation:users.
- Déplacement de sujets de #documentation:devs vers #documentation:theme-developers lorsqu’ils sont spécifiques au développement de thèmes ou de composants de thèmes.
- Mise à jour des titres de sujets pour plus de cohérence
- Utilisation du temps impératif pour les titres de sujets (et suppression de “comment” du titre).
- Utilisation de la capitalisation normale des phrases
- Mise en forme du contenu avec des titres commençant à H2
(En relation : nous avons également activé la Table des matières pour tous les sujets de documentation)
Dans certains cas, nous apportons des modifications au contenu lui-même, mais une analyse approfondie n’est pas notre objectif immédiat. Dans une future passe, nous aimerions faire des choses comme :
- Intégrer le contenu des réponses dans la documentation elle-même
- Supprimer toutes les réponses
- Configurer les sujets pour supprimer les réponses après 1 ou 2 mois
Ensuite, à l’avenir, nous fournirons des directives mises à jour sur la contribution de nouvelle documentation et la maintenance de la documentation existante, et nous mettrons à jour les sujets suivants :
Nous pourrions vouloir transformer davantage de documents en Wikis ou trouver de nouveaux propriétaires pour les documents lorsqu’ils sont maintenus par quelqu’un d’autre que l’auteur original, par exemple.
Nous pensons également qu’il pourrait y avoir une opportunité ici de créer un espace séparé pour que les gens puissent faire plus de “montrer et raconter” dans la lignée de certains contenus qui étaient sous #documentation:tips-and-tricks. Créer un espace pour de tels sujets en dehors de la documentation pourrait permettre de discuter davantage d’entre pairs. Mais, de manière similaire à ce que nous faisons actuellement avec la documentation, il serait peut-être utile d’avoir des espaces séparés pour les administrateurs système, les administrateurs et les développeurs pour ces discussions. Qu’en pensez-vous ?