FAQ du contributeur à la documentation

Pourquoi un workflow ?

Lorsqu’on travaille à plusieurs, il est nécessaire d’établir des règles et que chacun les respecte. 

Cela permet d’avancer plus vite et d’obtenir un résultat homogène.

Le flux de travail est rappelé dans la feuille Workflow du tableau de suivi.
Si vous avez un doute ou une question, venez en discuter dans le canal #documentation-fr du slack.

Top ↑

Je souhaite traduire des contenus, comment faire ?

  1. Rejoignez l’équipe.
  2. Lisez ce guide.
  3. Choisissez un article dans le tableau de suivi et y saisir votre pseudo dans la colonne Auteur trad. Puis sélectionner le statut En cours de traduction.
  4. Accédez au tableau de bord de HelpHub en français :
    1. Recherchez l’article à traduire.
    2. Vérifiez que le contenu de l’article est le même que celui en ligne sur HelpHub officiel.
    3. Traduisez les contenus et mettez-les en forme.
    4. Insérez le bloc réutilisable Contribution, convertissez-le en blocs normaux puis complétez-le.
  5. Lorsque la traduction est terminée, prévenez l’équipe sur le slack que l’article est en attente de relecture, dans ll’éditeur WordPress, pensez à cocher les options En attente de relecture et Activer la prévisualisation publique. Dans le tableau de suivi, modifier le statut de l’article à En attente de relecture.
  6. Tout au long de la traduction, n’hésitez pas à poser vos questions dans le canal #documentation-fr du slack.

Top ↑

Je souhaite rédiger des contenus, comment faire ?

  1. Rejoignez l’équipe.
  2. Lisez ce guide.
  3. Choisissez un des sujets d’article proposés dans le tableau de suivi (feuille Articles FR) ou proposez-en un nouveau dans le canal #documentation-fr du slack.
  4. Accédez au tableau de bord de HelpHub en français :
    1. Rédigez votre article. Appliquez lui les styles et la typographie.
    2. Insérez le bloc réutilisable Contribution, convertissez-le en blocs normaux puis complétez-le.
  5. Lorsque la rédaction est terminée, prévenez l’équipe sur le slack que l’article est en attente de relecture.
  6. Tout au long de la rédaction, n’hésitez pas à poser vos questions dans le canal #documentation-fr du slack.

Top ↑

Je souhaite relire des contenus, comment faire ?

  1. Rejoignez l’équipe.
  2. Lisez ce guide.
  3. Choisissez un article dans le tableau de suivi et y saisir votre pseudo dans la colonne Relecteur 1 ou Relecteur 2.
  4. Affichez la version anglaise de l’article via le lien dans le tableau de suivi.
  5. Cliquez sur le lien de l’article dans le canal #documentation-fr.
  6. Accédez au tableau de bord de HelpHub en français, relire en vérifiant les points suivants :
    1. La qualité de la traduction, le respect des dénominations de l’interface de WordPress, les liens (qui doivent être relatifs s’ils pointent vers un autre article de la documentation).
    2. L’orthographe, la typographie et les styles.
  7. Indiquez vos nom et prénom dans le bloc Contribution.
  8. Indiquez les corrections à faire ou que vous avez effectuées dans un fil sous le message posté par l’auteur de la traduction.
  9. Lorsque la relecture est terminée, prévenez l’équipe sur le slack que l’article est en attente d’une seconde relecture. Ou si vous faites la seconde relecture, publiez l’article et annoncez sa publication sur le slack. Dans le tableau de suivi, passez l’article au statut Validé première relecture, ou À revoir, ou Publié si vous avez publié l’article après sa seconde relecture.
  10. Au cours de la relecture, n’hésitez pas à poser vos questions dans le canal #documentation-fr du slack.

Top ↑

Quels styles utiliser ?

Pour les styles, reportez vous au guide de traduction de la documentation où vous pouvez télécharger une fiche mémo.

Rappels : 

  • pas de style gras sur les titres ;
  • pas de cumul gras + italique ;
  • pas de style gras sur les liens ;
  • pas de soulignement (réservé aux liens).

Top ↑

Comment insérer des liens et des ancres ?

Les liens vers d’autres articles de la documentation doivent être mis en relatif donc sous la forme /support/slug-article.
Les liens qui pointent vers des contenus en anglais doivent avoir la mention « en anglais » dans leur libellé, comme ceci : PhpMyAdmin (en anglais). Le libellé peut être éventuellement en anglais.
Par contre, les liens vers des articles de la documentation qui ne sont pas encore traduits doivent avoir un libellé en français et un lien relatif.
Pour les liens, tout ceci est expliqué plus en détails dans le guide.
Vous trouverez aussi dans le guide des explications pour les ancres.

Top ↑

Comment réaliser les captures d’écran ?

Il n’est pas obligatoire de faire les captures d’écran en français.

Pour réaliser des captures d’écran, il vous faudra une installation de WordPress avec la dernière version et le thème par défaut qui lui est associé.

Quelques recommandations :

  • Utilisez un environnement clair. Pas de thème sur le navigateur.
  • Les éléments (tels que photos ou vidéos) sur la capture doivent être libres de droits.
  • Compressez vos images.
  • Nommez-les avec des termes décrivant le contenu de l’image, par exemple « ecran-reglages-lecture-page-accueil » sans accent, ni caractères spéciaux.
  • Si vous devez remplacer votre capture, supprimez-la d’abord de la médiathèque.
  • N’oubliez pas de compléter la balise alt.

Top ↑

Le bloc Contribution, comment ça marche ?

  • Accédez à l’outil d’insertion de blocs, puis Réutilisables, choisissez Signature contribution.
  • Cliquez deux fois sur l’outil Convertir en blocs normaux puis éditez le lien en indiquant vos prénom et nom et ajoutez votre pseudo wordpress.org à la fin de l’URL.

Top ↑

Le contenu de l’article a été mis à jour depuis son importation

Si le contenu que vous souhaitez traduire a été mis à jour depuis son importation dans le helphub fr :

  • Ne commencez pas la traduction.
  • Et là encore, communiquez sur le canal #documentation-fr du slack et demandez que le contenu soit ré-importé. Précisez bien le titre de l’article et mettez le lien de l’article en anglais dans votre message.
  • Dans un délai de quelques jours, le nouveau contenu devrait être importé et, dans le cas contraire, n’hésitez pas à le demander à nouveau.
  • Vous serez prévenu sur le slack quand le contenu sera ré-importé.

Top ↑

J’ai terminé la traduction/rédaction d’un article, comment le faire publier ?

Communiquez à l’équipe que votre article est en attente de relecture sur le canal #documentation-fr du slack, en copiant le lien vers l’article situé dans la colonne latérale de l’éditeur.
N’oubliez pas de mettre le statut de l’article à En attente de relecture dans le tableau de suivi.
Vous devriez avoir rapidement des retours. Dans le cas contraire, postez à nouveau votre message.

Top ↑

J’ai repéré une erreur dans la documentation, que faire ?

Pour l’instant, nous n’avons pas de système pour déclarer les erreurs, donc le seul moyen de nous signaler une erreur est de nous la communiquer sur le canal #documentation-fr du slack.
Pensez à mettre le lien vers l’article dans votre message et à bien décrire l’erreur.

Top ↑

Un article doit être mis à jour, comment faire ?

Pour l’instant, il n’y a pas de procédure bien définie :

  • S’il s’agit de modifications mineures comme par exemple la correction d’un lien ou de la dénomination d’un élément d’interface, effectuez la correction puis insérez, s’il n’y est pas, le bloc Journal des modifications, convertissez-le en blocs normaux, puis complétez-le comme il est suggéré dans le bloc, en indiquant par une phrase courte les modifications apportées. Changez aussi la date dans le bloc Signature Contribution. Après avoir fait la modification, signalez la mise à jour de l’article dans le canal #documentation-fr.
  • S’il s’agit de modifications plus importantes ou qui concerne plusieurs articles, une discussion s’impose dans le canal #documentation-fr du slack pour établir le contenu de la mise à jour.

Top ↑

Je traduis/rédige un article concernant un bloc, comment mettre en place la mutualisation des contenus ?

La mutualisation des contenus consiste à faire des renvois vers d’autres articles pour tout ce qui est commun à tous les blocs (outils, réglages). L’objectif est d’éviter la répétition des mêmes informations, dans chacun des articles qui décrivent un bloc.
Les articles qui permettent cette mutualisation sont :

  • Ajouter un nouveau bloc
  • Barre d’outils des blocs
  • Contrôles de texte enrichis des blocs
  • Options supplémentaires des blocs
  • Réglages communs des blocs
  • Réglages avancés des blocs

Pour créer les renvois dans les articles, il existe plusieurs blocs réutilisables à insérer dans l’article sur le bloc. Ces blocs réutilisables ne doivent pas être convertis en blocs normaux.

La page Mutualisation des contenus concernant les blocs explique en détail la méthode à suivre.

Dernière mise à jour :