Un projet (open-source) ce n’est pas que du code : exemple avec PostGIS

logo postgisOn l’oublie trop souvent lorsqu’on est développeur (parfois un peu sciemment il faut l’avouer), mais un projet n’est pas que du code. La documentation par exemple, est un élément fondamental dans la bonne réussite d’un projet. Et dans un projet open-source, qui sera utilisé par de multiples personnes autour du monde, et donc dans plusieurs langues, la traduction de la documentation est également essentiel pour l’adoption du projet. Jacky nous avait parlé de la traduction de la documentation utilisateur du plugin QGIS LSCI dans un précédent article. Je profite aujourd’hui du temps open-source dédié chez Oslandia pour aborder la traduction de la documentation PostGIS. Vincent détaillera dans un article à venir très prochainement la philosophie du temps open-source chez Oslandia.

La traduction française de PostGIS n’est clairement pas à la hauteur de qualité du logiciel, avec certaines sections à peine traduites et peu de sections dépassant les 50%. Étant un gros utilisateur de PostGIS (je l’utilise sur 99% mes projets), il était tout naturel de contribuer en retour. Je trouve toujours enrichissant pour un développeur de s’éloigner de temps à autres du code pour avoir d’autres points de vue : là aussi les tâches de documentation sont assez naturelles pour moi. Par contre, la traduction, c’était quelque chose d’un peu nouveau, donc je me dis que partager mon expérience peut aider d’autres personnes à se lancer !

Démarrage

Fût un temps, la traduction c’était très pénible et peu ergonomique (coucou Qt Linguist). Désormais plus besoin de cloner le dépôt de code, d’installer un logiciel spécifique, de commit, et de se manger des conflits à gérer. L’OSGeo a mis en place une interface web, avec Weblate, pour la traduction des projets hébergés, dont PostGIS. Seul pré-requis pour contribuer : avoir un compte OSGeo, à créer sur leur site. Une fois le compte créé, on peut contribuer à OSGeo Weblate, en particulier à la section Français de PostGIS.

Dashboard Weblate PostGIS frenchSur le tableau de bord, on voit d’un coup d’œil le statut : en bleu les traductions validées, en vert les traductions remplies (en attente de validation), et en rouge les traductions manquantes ou avec des problèmes. Bref : il y a du boulot !

Mais avant de plonger dans la traduction en elle-même, je trouve qu’il est important de déjà lire un peu la documentation en elle-même, et ce qui a déjà été traduit pour s’imprégner du style, l’idée étant que le style soit cohérent tout au long de la documentation – ce qui n’est pas toujours évident car déjà en anglais il peut ne pas toujours être cohérent… Un exemple est la traduction du we, abondamment utilisé dans l’introduction de la documentation PostGIS : faut-il le traduire par nous ou par on ? Ici, la traduction existante utilise nous.

Une fois la vue d’ensemble absorbée, reste à savoir par où commencer. Pour moi, la documentation est une vitrine du logiciel, donc il faut particulièrement soigner les points d’entrée, autrement dit les sections par lesquelles un utilisateur peut être amené à arriver sur la documentation : introduction, installation, FAQ. Voilà déjà les trois sections sur lesquelles je me suis concentré pour démarrer !

Prise en main

L’ergonomie de Weblate est, je trouve, très réussie, car la prise en main est immédiate : à partir d’un composant on voit immédiatement ce qu’il reste à faire, et en cliquant sur, par exemple, « Untranslated strings » on file vers les traductions à effectuer, que l’on peut enchainer à grande vitesse.

Weblate - statut d'un composant

Weblate - traductionEt hop, c’est parti ! Je ne reviendrai pas sur les principes de comment faire une bonne traduction, mais d’après mes lointains souvenirs de prépa, je retiens que le mot-à-mot est à proscrire, et la question à se poser au moment de se relire est : « Est-ce que j’aurai écrit cela naturellement ? ».

Astuces

Étant plutôt anglophone dans mon quotidien, j’avoue que je n’ai pas forcément les termes français en tête, mais on peut s’appuyer sur diverses sources pour s’aider lorsqu’il nous manque un terme. On peut donc tout à fait participer à la traduction d’un logiciel même si l’on est pas expert technique sur le sujet !

  • Le premier réflexe est de voir si le terme a déjà été traduit. Weblate propose une interface recherche très complète, et nous permet de rechercher des mots. Par exemple, je recherchais le terme « index binding », et hop, je vois que ça a déjà été traduit en français par « liaison des index ».
  • Parfois cela a déjà été traduit dans d’autres langues. Je ne lis pas l’italien, mais quand les traductions existent cela peut quand même dépanner.
  • Nos propres supports de formation sont entièrement en français, cela donne une autre source,
  • Pour les termes techniques, un peu de recherche via par exemples :
  • Je n’en ai pas eu besoin jusqu’à présent, mais il ne faut pas oublier le support de la communauté, notamment via les canaux de discussion.

Et pour les aficionados des raccourcis clavier, Weblate permet d’effectuer beaucoup d’actions (si ce n’est toutes) au clavier. Quand on a beaucoup de petits textes inchangés (comme des noms), enchainer Ctrl+O, Ctr+Y et Alt+Enter, ça va quand même plus vite que trois clics.

Conclusion

The translation has come to an endAprès seulement une journée, j’ai réussi à traduire les trois sections que je visais : l’introduction, l’installation et la FAQ PostGIS, ce qui est au-delà de mes espérances initiales. Et même si mes traductions n’ont pas encore été validées sur Weblate, elles sont déjà disponibles dans la version dev du manuel, ce qui est très valorisant. Prochain objectif : traduire les 77% restants !