D’où vient la documentation de Mageia ?

Nous avons demandé à Lebarhon de l’équipe Documentation d’écrire un article à propos du travail de l’équipe et des diverses ressources qu’ils ont mises en place pour nos utilisateurs. Dans cet article, il présente leur travail sur la « Documentation Officielle » et sur le wiki.

La documentation de Mageia est composée de deux parties : la « Documentation Officielle » et le wiki. La façon dont elles sont gérées est très différente.

La documentation officielle et le wiki de Mageia

Incluses dans la documentation officielle, nous avons l’aide de l’Installeur Classique, l’aide de l’Installeur Live et l’aide de NetInstall (installation par le réseau). Cette documentation, directement liée au processus d’installation, est mise à jour et livrée avec chaque publication de Mageia. L’aide du CCM (Centre de Contrôle de Mageia) appartient aussi à la documentation officielle. Elle est régulièrement mise à jour et empaquetée pour rejoindre les mises à jour habituellement téléchargées. Toute la documentation officielle est écrite et validée par les équipes de Mageia puis traduite dans plus de 20 langues.

Le wiki suit un processus très différent. Tout le monde peut s’inscrire puis écrire, améliorer ou traduire une page wiki. Le rédacteur est généralement quelqu’un qui maîtrise un sujet et désire le promouvoir (application, jeu, outil, paramétrage, astuce, information, …). Quiconque désire traduire une page est le bienvenu pour y procéder. La plupart des pages wiki sont traduites entre 1 à 5 langues – la procédure de traduction est encore peu pratique, nous envisageons de déployer une extension de MediaWiki pour la simplifier (nous encouragerons donc à ce moment là les contributeurs à traduire des pages du wiki). Les équipes de Mageia surveillent le wiki pour garantir son bon fonctionnement (et plus spécialement lutter contre le spam), mais elles ne peuvent vérifier toutes les pages en détail.

Qui écrit la documentation officielle ?

La documentation officielle de Mageia est tributaire de l’implication de plusieurs équipes :

• Docteam (équipe documentation), les rédacteurs, composée d’environ 10 personnes, certaines ayant l’anglais pour langue maternelle.
• i18n, les traducteurs, composée de 1 à 10 personnes par langue (environ 20 langues)
• Atelier, elle, gère la publication et le suivi de la progression des traductions.

Les équipes sont pilotées par un leader et un adjoint élus. Tout nouveau volontaire est bien sûr le bienvenu.

Le mode opératoire

La documentation officielle suit un processus strict. Premièrement, quelques semaines avant une publication, Docteam rédige et/ou met à jour les textes en anglais au format Docbook au moyen de Calenco. Cela comprend l’élaboration des copies d’écran de la publication à venir (pour correspondre aux nouvelles compositions graphiques de l’installeur et du MCC ainsi qu’aux modifications de l’interface graphique), la vérification et la relecture par un anglophone natif. Ensuite le texte original en anglais est publié dans les formats supportés : html, epub et pdf.

Puis, Atelier prend en charge la conversion des fichiers texte en .po (fichiers de traduction) et leur transfert dans Transifex, grace à l’utilisation de scripts maison. Les traducteurs peuvent alors procéder aux traductions via Transifex ou n’importe quel autre outil ayant leur préférence, et aussi créer les copies d’écran traduites et les placer dans Calenco.

Enfin, Atelier peut publier la documentation dans toutes les langues supportées et dans tous les formats ci-dessus et l’intégrer dans les nouvelles images ISO (utilisant ici aussi des scripts maison). L’étape finale diffère pour l’aide du CCM car il n’est pas livré avec la publication mais empaqueté comme tous les autres paquets.

Rien de tout cela n’existe pour le wiki, la rédaction est réalisée par des bénévoles n’importe quand et dans la langue de leur choix. Puis, les améliorations et traductions sont apportées par d’autres bénévoles, s’il s’en trouvent (pas de date butoir). Cela ne signifie pas qu’on ne peut trouver d’informations intéressantes dans le wiki, au contraire, beaucoup de guides et de pages d’aide y sont présents.

L’avenir de la documentation

Bien que fonctionnant plutôt correctement, les équipes Mageia ont quelques idées pour améliorer la documentation :

• Approfondir encore la documentation à l’intention des nouveaux arrivants, en donnant encore plus de détails et d’aide au dépannage (UEFI, partition de boot BIOS, paramétrage de Grub2, Optimus…).
• Il existe encore quelques outils du CCM ou certaines de leurs spécificités qui ne sont pas documentés (car ils font appel à du matériel exotique).
• Nous aimerions livrer les ISO avec un chapitre aussi exhaustif que possible sur le dépannage visant à aider les utilisateurs mal pourvus par le réseau Internet (téléchargement difficile, peu d’accès aux forums, à l’aide, etc.).
• Recruter plus de traducteurs pour renforcer les petites équipes et offrir davantage d’aide traduite (surtout dans le wiki).
• Recruter plus de développeurs pour améliorer les scripts maison (par exemple au sujet de la gestion des copies d’écran dans l’aide officielle) et pour mettre à jour le wiki vers un support multilangues et une meilleure gestion de la sécurité.

Il n’y a pas de bonne distribution sans bonne documentation dans de nombreuses langues et pas de bonne documentation sans de bonnes et nombreuses équipes. Nous comptons sur vous tous pour venir renforcer nos équipes !

Traduction du billet Where does the Mageia Documentation come from? publié sur le blog anglophone de Mageia par Lebarhon.