Compte rendu de la 3ème réunion Documentation du 8 mars 2021

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

Ordre du jour

  • Point sur l’avancement.
  • Liste des actions à mener en rapport avec la sortie de la version 5.7 de WordPress.
  • Présentation d’une nouvelle extension permettant de planifier les mises à jour d’articles, prochainement disponible.
  • Le GitHub WordPress/HelpHub, un moyen pour faire remonter les erreurs rencontrées dans le contenu de la documentation.
  • La pertinence de reprendre les réglages communs dans les articles traitant des blocs de l’éditeur ?
  • L’utilisation d’images pour désigner les icônes dans les articles et leur non-accessibilité.

Personnes présentes

Point sur l’avancement

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

Pas d’importation de nouvel article.

Nouvelle fonctionnalité : les commentaires

Ils sont apparus depuis quelques semaines sur le site de la documentation : les commentaires.

Il est désormais possible d’autoriser les commentaires sur les articles, en cochant la case Allow comments de l’onglet Discussion des réglages d’un article.

Nous décidons d’activer en masse cette fonctionnalités sur les articles existants de la documentation en français. Cela nous permettra de recueillir des avis de nos lecteurs et lectrices.

Jb propose de créer un slackbot afin que nous soyons averti⋅e·s sur le canal #documentation-fr du Slack lorsqu’un commentaire est publié.

Liste des actions à mener en rapport avec la sortie de la version 5.7 de WordPress

Comme évoqué lors de la dernière réunion, la liste des notes de développement a été utilisée pour recenser les mises à jour à faire dans la documentation.

Peu d’articles ont été relevés comme étant à mettre à jour, voici la liste à ce jour :

Les paragraphes de ces modifications sont déjà rédigés, il seront intégrés prochainement dans les articles concernés.

La version 5.7 introduit également la standardisation des palettes de couleur du tableau de bord (en anglais). Il pourrait être intéressant de créer un article à ce sujet afin de diffuser cette information.

Présentation d’une nouvelle extension permettant de planifier les mises à jour d’articles, prochainement disponible

Jenny nous présente une nouvelle fonctionnalité apportée par une extension qui apparaîtra bientôt sur le site de la documentation et qui sera utile aux auteurs et autrices, car elle permettra de planifier des modifications d’articles. Cette extension propose les fonctionnalités suivantes :

  • À partir de l’éditeur de blocs, apportez des modifications à une publication déjà publiée et planifiez-en la mise en ligne à une date ultérieure.
  • Modifiez les mises à jour programmées, y compris le contenu et la date de publication future.
  • Dans l’interface utilisateur de l’éditeur de blocs ainsi que dans d’autres écrans d’administration, visualisez les publications ayant une mise à jour programmée.
  • Affichez une liste de toutes les mises à jour programmées.
  • Comparez le contenu de mise à jour programmée au contenu publié actuel.

Ces fonctionnalités seront disponibles pour tous les types de publication prenant en charge les révisions.

L’extension qui apportera ces fonctionnalités est disponible sur GitHub.
Pour en savoir plus, Lire l’annonce sur le site Make (en anglais).

Le GitHub WordPress/HelpHub, un moyen pour faire remonter les erreurs rencontrées dans le contenu de la documentation

Jenny a découvert qu’il existait un dépôt GitHub pour le site support (documentation).
Ce dépôt peut être utilisé pour remonter les erreurs rencontrées sur la partie internationale de la documentation.

Étant donné qu’il peut être compliqué pour une personne non aguerrie de publier une issue sur GitHub, il est proposé de continuer à fonctionner comme actuellement : discuter des problèmes rencontrés sur notre canal #documentation-fr.
Lorsque nous aurons plusieurs problèmes à remonter à l’équipe internationale, une personne pourra créer une issue sur le dépôt GitHub.

La pertinence de reprendre les réglages communs dans les articles traitant des blocs de l’éditeur ?

Marie soulève cette question après avoir relu certains articles qui répètent les mêmes contenus à propos des explications sur comment ajouter/insérer un bloc.

Cela pose plusieurs problèmes :

  • Nous avons beaucoup d’articles à mettre à jour lorsque c’est nécessaire (évolutions de l’éditeur).
  • Manque de cohérence entre les différents articles (terminologie et captures d’écran différentes).

À l’image des articles mutualisés créés par Jenny (Réglages avancés des blocs, Options supplémentaires des blocs et Contrôles de texte enrichis des blocs), Marie propose de créer d’autres articles mutualisés :

  • Réglages des blocs (typographie, réglages de couleur, styles).
  • Barre d’outils des blocs.
  • Fil d’ariane.

Il sera demandé aux auteurs et autrices de faire référence à ces articles mutualisés lorsque nécessaire, au lieu de rédiger du contenu dans l’article en cours de traduction. Il est même envisagé de créer des blocs réutilisables pour faire référence facilement à ces contenus.

L’utilisation de ces articles mutualisés fera l’objet d’une mise à jour du guide de traduction de la documentation.

L’utilisation d’images pour désigner les icônes dans les articles et leur non-accessibilité

Marie décrit un problème d’accessibilité lors de l’utilisation d’images (captures d’écran) pour désigner des icônes de l’interface.

En effet, ces images ne sont pas accessibles si elles ne contiennent pas de texte alternatif et si le libellé de l’icône décrite n’est pas indiqué à côté de l’image.

Se pose également la question des mises à jour de la documentation lorsque l’interface est mise à jour : plus on a ce type de captures d’écran, plus ils sera fastidieux de les maintenir à jour.

Il est décidé d’essayer de limiter l’usage des captures d’écran au sein du contenu. Elles peuvent être utiles mais il n’est pas nécessaire de les répéter à chaque mention d’un bouton par exemple.
Lorsqu’elles sont utilisées, il faut indiquer le libellé du bouton puis l’image, sans texte alternatif.

Fin de la réunion à 13h10.

La prochaine réunion aura lieu le lundi 12 avril 2021.