Compte rendu de la 4ème réunion Documentation du 12 avril 2021

La quatrième réunion de l’équipe de la documentation s’est tenue le lundi 12 avril 2021 à midi heure française, en visioconférence.

Ordre du jour

  • Point sur l’avancement.
  • Annonce du WPTD-FR 2021.
  • Présentation du « Season of docs » par Justin Ahinon.
  • Fonctionnement de la mutualisation des contenus pour les articles concernant les blocs.
  • Styles à utiliser dans la documentation.

Personnes présentes

Point sur l’avancement

Par rapport au point précédent du 8 mars 2021 :

  • 1 article traduit (130 articles publiés sur 230 soit 56.5%).
  • 2 articles créés (12 articles publiés sur 26 soit 46.2%).

Au vu de ces chiffres, l’avancement semble faible, mais ce bilan est à relativiser car nous avons réussi à mettre en place la mutualisation des contenus concernant les blocs (voir ci-dessous) et 9 articles sont en attente de relecture (dont plusieurs devront être remaniés suite à cette mutualisation des contenus car ils concernent des blocs).

Annonce du WPTD-FR 2021

Marie nous annonce que le WordPress Translation Day – FR 2021 aura lieu le 30 avril de 14h à 18h. Valérie indique qu’elle communiquera cette information sur le site de l’association WPFR.
JB rappelle que les WPTD sont l’occasion de bien avancer sur des projets et de former des personnes qui débutent dans la contribution à la traduction.
Pour la traduction de la documentation, JB propose que nous préparions une petite liste d’articles courts qui se prêteraient bien à former de nouvelles personnes.

Présentation du « Season of docs »

Justin Ahinon qui fait partie de l’équipe de Documentation de WordPress nous présente le Google Season of docs 2021 : il s’agit d’un programme de Google afin de soutenir la rédaction et l’amélioration de documentations techniques concernant des projets open source. En attendant l’annonce des projets retenus, qui est prévue le 16 avril 2021, les commentaires sont toujours ouverts sur la liste d’idées de projets. Si vous êtes intéressés par ce projet, il est encore temps pour vous faire connaître auprès de Justin, ou de nous en parler.

L’an dernier le « Season of docs » avait débouché sur la rédaction d’un excellent guide concernant la mise en forme de la documentation de WordPress mené par Atharva Dhekne.

Fonctionnement de la mutualisation des contenus pour les articles concernant les blocs

La mutualisation des contenus pour les articles concernant les blocs a été mise en place par Marie et Jenny. Le principe est simple, tous les contenus qui sont répétés dans chaque article de bloc ont été déplacés dans des articles dédiés qui sont ciblés dans les articles concernant les blocs.

Jenny explique comment cette mutualisation a été organisée.

Nous avons plusieurs articles mutualisés qui concernent :

Et des renvois vers ces articles mutualisés dans les articles concernant les blocs s’effectuent via des blocs réutilisables.

Pour guider les traducteurs/traductrices et rédacteurs/rédactrices, une page du handbook dédiée à l’implémentation de ces renvois vers les articles mutualisés a été rédigée.

JB suggère de présenter cette organisation des contenus avec un exemple lors du WPTD-FR du 30 avril.

Justin est très intéressé par ce concept de mutualisation. Nous lui faisons part que nous avons déjà informé l’équipe Documentation de WordPress et proposé ces contenus, mais cette proposition n’a débouché sur aucune réponse. Justin décide qu’il en parlera à la réunion de l’équipe qui a lieu quelques heures après, et Jean-Baptiste lui fournira une capture d’écran pour expliquer ce que nous avons mis en place.

Styles à utiliser dans la documentation

Dans un souci d’homogénéisation des styles utilisés dans les articles de la documentation dont l’objectif est de faciliter la compréhension de la documentation, un mémento des styles à utiliser dans la documentation a été ajouté au Guide de traduction de WordPress en français.

Pour rédiger cette page, Jenny s’est appuyée sur le très complet guide des styles de la documentation de WordPress (issu du Season of Docs de 2020).

Les contributeurs et contributrices à la documentation de WordPress sont invités à prendre connaissance des styles à utiliser et à les implémenter au maximum dans les articles qu’ils traduisent ou rédigent, en gardant en tête lors des traductions, que ces styles sont prioritaires sur la mise en forme des articles sources en anglais.

Fin de la réunion à 13h.

La prochaine réunion aura lieu le lundi 10 mai 2021.


Note : la présentation de la mutualisation des contenus concernant les blocs, faite par Justin lors de la réunion de l’équipe Documentation de WordPress, a retenu l’attention de l’équipe. Voir le compte-rendu de cette réunion – paragraphe Open Floor. Merci Justin pour cette transmission à l’équipe Documentation de WordPress.