Mise à jour du contenu des articles

WordPress est un outil en constante évolution, la mise à jour de sa documentation est donc incontournable, surtout si l’on veut atteindre l’objectif d’être utile aux utilisateurs et utilisatrices.

À chaque nouvelle version de WordPress, des fonctionnalités sont ajoutées, d’autres sont modifiées ou encore remplacées. S’il est assez fastidieux de suivre ces évolutions, il existe néanmoins des sources qui permettent de le faire, grâce à l’équipe qui gère la documentation officielle en anglais.

Ainsi pour chaque version de WordPress, un tableau de bord de projet concernant les documentations relatives à WordPress, à savoir : documentation utilisateur, documentation développeur, les notes de développement et le guide des changements techniques, est créé. Voici par exemples ceux des versions 6.0 et 6.1.

Autre source pour mettre à jour la documentation utilisateur : le documentation-issue-tracker qui permet, en triant les issues par version et/ou par priorité, de connaître les modifications à apporter.

Pour nous organiser, deux documents ont été créés :

• Un kanban sous Notion nommé Modification des articles qui reprend les « issues » sélectionnées.
• Une feuille nommée « MAJ Articles » permettant de suivre ces mises à jour d’articles a été créé dans le tableau de suivi.

Méthodologie pour effectuer les mises à jour

Top ↑

Étape 1 : définir les articles à modifier et les modifications à effectuer

La liste des articles à modifier est établie à partir de la liste des « issues » en ne tenant compte que des « issues » classées en « priorité haute » dans un premier temps.

Ensuite, il faut définir les modifications à effectuer dans l’article. Lorsque celles-ci sont définies, alors l’état « En cours » est affecté à l’article dans la liste des modifications à effectuer, et l’article est ajouté dans le tableau de suivi.

Top ↑

Étape 2 : réalisation des modifications

Lorsqu’une personne décide d’effectuer des modifications sur un article de la liste proposée dans le tableau de suivi, il lui faut indiquer son pseudo wp.org dans la colonne « Auteur modifs », puis modifier la valeur à « En cours de modification » dans la colonne « Statut ».

Puis, il faut accéder à l’article pour l’éditer et y effectuer une première modification, puis cliquer sur le bouton Select an action situé à côté du bouton Mettre à jour, puis cliquer sur Save for later dans le menu déroulant.

Dans la colonne latérale des réglages de l’article, dans la section Save for later, sélectionnez une date assez éloignée pour laisser le temps aux relecteurs de valider les modifications, puis cliquez sur le bouton Save update. Cela a pour effet de créer une copie de l’article dans une publication complètement déconnectée de l’article original.

Le message suivant s’affiche confirmant la création d’un article de type Update :

• Si vous cliquez sur Continue editing your update, vous restez dans l’éditeur (logiquement c’est cette option que vous devez choisir).
• Si vous cliquez sur Edit original article, vous retournez sur l’article original.
• Enfin, si vous cliquez sur View all article updates, vous affichez l‘écran Updates (aussi accessible via le menu Articles, puis Updates).

Dans l’éditeur, vous disposez donc maintenant d’une copie de l’article original avec une première modification. Poursuivez le travail de mise à jour du contenu de l’article, puis ajoutez une ligne avec la date dans le journal des modifications, par exemple :

Lorsque vous avez terminé vos modifications (et de temps en temps) cliquez sur le bouton Update afin d’enregistrer vos modifications. Notez que ce bouton Update (à la place de Mettre à jour) vous signale que vous êtes bien sur une publication de type Update.

Top ↑

Étape 3 : demander la relecture

Avant de quitter l’éditeur, copiez l’url de votre article mis à jour (votre update), puis la coller dans le tableau de suivi dans la colonne « URL Update », ce qui facilitera l’accès pour la personne qui effectuera la relecture.

Sélectionnez ensuite le statut « En attente de relecture » puis faites un court message dans le canal #documentation-fr du Slack WordPressFR pour demander la relecture.

Top ↑

Étape 4 : relecture

Dans le tableau de suivi, la personne qui effectue la relecture modifie le statut de l’article à « En cours de relecture » et indique son pseudo wp.org dans la colonne « Relecteur », puis accède à l’article modifié via le lien de la colonne « URL Update ».

La relecture nécessite de prendre connaissance des modifications réalisées qui sont listées dans le journal des modifications situé en fin d’article, et de valider celles-ci en ayant vérifié qu’elles sont conformes à l’interface et/ou au fonctionnement de WordPress pour la dernière version en date ou la version pour laquelle les modifications ont été réalisées.

Si les modifications sont correctes, le relecteur ou la relectrice :

1. Indique la date du jour dans le journal devant la description des dernières modifications ainsi que dans les crédits de contribution. Ainsi la date de la dernière modification mentionnée dans le journal et celle des crédits « Dernière mise à jour le… » correspondent.
2. Publie immédiatement ou laisse WordPress publier automatiquement à la date planifiée (non recommandé). Pour publier immédiatement, cliquez sur le bouton Select an action puis sur l’élément de menu Publish now (voir capture ci-dessous).
3. Passe le statut à « Publié » dans le tableau de suivi et modifiez l’état à « Terminé » dans la liste des modifications à effectuer.

Le relecteur ou la relectrice partage l’avancement dans le canal #documentation-fr du slack.

Lorsque l’article de type Update est publié, il remplace l’article original.

Si certaines modifications ne sont pas correctes ou sont à discuter, il faut alors changer le statut à « A revoir » dans le tableau de suivi et en informer la personne qui a fait les modifications.

Dernière mise à jour : 27 juillet 2023