Compte-rendu de la 20ème réunion de l’équipe Documentation du 10 novembre 2022

La vingtième réunion de l’équipe de la documentation de WordPress en français s’est tenue le jeudi 10 novembre 2022 à treize heures (heure française), en visioconférence.

Ordre du jour

  • Point avancement.
  • Espace de travail sous Notion.
  • Mise à jour de la documentation pour la version 6.1.

Personnes présentes

Point avancement

Depuis la dernière réunion du 10 octobre 2022 :

  • Pas de nouvel article traduit, ni rédigé, ni importé du codex.
  • 1 article en attente de relecture (publié depuis).
  • +2 articles importés.

Le pourcentage global d’avancement est de 77.3% (sans tenir compte du Codex).

Pour les pages du Codex, l’avancement global est toujours de 48.6%.

Contenu de l’article Réglages communs des blocs.

Ce sujet n’était pas à l’ordre du jour mais il est évoqué dans le point fait sur l’actualité de la documentation officielle de WordPress. L’équipe de la documentation officielle a, en effet, mis en place des articles qui présentent des fonctionnalités communes à tous les blocs ou à un très grand nombre de blocs, soit les réglages de typographie, couleur, bordure, mise en page, dimensions, styles. Ce que nous avons déjà réalisé lors de la mise en place de la mutualisation des contenus pour les articles concernant les blocs, dans l’article Réglages communs des blocs.

La discussion se porte sur : découpons-nous l’article « Réglages communs des blocs » en plusieurs articles (comme dans la version officielle en anglais) ou complétons-nous l’article « Réglages communs des blocs » avec les éléments manquants (à savoir mise en page et bordure) ?

Les avantages d’un seul article :

  • De n’avoir rien à modifier dans les articles concernant les blocs qui contiennent tous déjà un lien vers cet article des réglages communs.
  • Les lecteurs et lectrices de la documentation peuvent prendre connaissance d’autres réglages communs juste en les voyant dans le sommaire.
  • Pas de création de nouveaux articles.
  • Conservation du référencement.

Les inconvénients d’un seul article :

  • Article au contenu assez long.
  • Le renvoi vers l’article des réglages communs peut être effectué uniquement pour un seul type de réglages, ce qui peut entraîner une certaine confusion concernant les réglages des blocs pour les utilisateurs/utilisatrices de la documentation.

Les avantages de plusieurs articles :

  • Clarté pour les utilisateurs et utilisatrices.
  • Synchronisation entre le HelpHub officiel et HelpHub FR simplifiée.

Les inconvénients de plusieurs articles :

  • Il faut effectuer le découpage en plusieurs articles et créer de nouveaux articles.
  • Il faut ajouter les liens vers les articles dans chaque article concernant un bloc selon les réglages que le bloc propose (demande donc à vérifier les réglages présents pour chaque bloc).
  • Perte du référencement.

🚩 L’équipe opte pour une mise à jour de l’article « Réglages communs des blocs » car c’est cette option qui implique le moins de travail à effectuer.

Espace de travail sous Notion.

L’association WPFR est ok pour financer un outil pour le travail collaboratif de l’équipe de documentation. Pour l’instant, un espace de travail Notion contient les informations concernant les réunions, le calendrier de publication, les tableaux d’avancement, ect. D’autres outils auto-hébergés ont été rapidement testés afin de voir si on pouvait utiliser un autre outil que Notion.

Nous discutons sur ces outils auto-hébergés : le travail lié à l’installation-maintenance d’un tel outil est évoqué comme étant un frein car gourmand en temps, tout comme la recherche de l’outil lui-même, ainsi que le temps nécessaire à sa prise en main.

🚩 L’équipe choisit donc de conserver l’outil Notion afin de ne pas engendrer de travail supplémentaire lié à la gestion du travail de l’équipe.
L’espace actuel va être migré dans un nouvel espace car il n’est pas correctement rattaché à l’abonnement de l’association WPFR.

Mise à jour de la documentation pour WP 6.1

La liste des issues concernant la version 6.1 avait été reportée dans un tableau/kanban sous Notion, cette liste a été complétée, et des éléments ont été ajoutés pour chaque item de la liste :

  • Un lien vers issue GitHub (afin de ne pas recopier les actions à mener qui sont déjà détaillées dans l’issue GitHub – même si ces actions doivent être adaptées au cas par cas à la version française puisque les contenus des articles ne sont pas à 100% synchronisés).
  • Des étiquettes Versions WP ont aussi été ajoutées quand des modifications existent pour les versions 5.9 et 6.0 de WordPress.
  • Des étiquettes Type (MAJ, Création d’article, Sans Objet) ont été ajoutées afin de pouvoir visualiser l’action globale à mener pour l’article.

🚩 Cette liste devra être mise à jour, au fur et à mesure de l’avancement, mais aussi avec les nouvelles issues déclarées dans GitHub.

Par ailleurs une page de documentation concernant la procédure de mise à jour des articles va étré rédigée dans le handbook, lorsqu’elle sera publiée, un lien sera ajouté dans le canal #documentation-fr du slack WordPressFR


La réunion se termine à 14H.

La prochaine réunion est prévue le 1er décembre 2022 à 13h.

#compte-rendu