Directives pour la vérification d’articles en anglais

Contributors Contributors Dernière mise à jour: il y a 2 semaines

Nos vérificateurs et vérificatrices de la base de connaissances sont des personnes contributrices et membres du personnel de Mozilla ayant de l’expérience et des compétences dans la rédaction de documentation d’assistance. Voici quelques directives pour la vérification des articles.

Objectif

En tant que vérificateur ou vérificatrice de la base de connaissances, votre rôle est essentiel pour maintenir l’exactitude, la clarté et la cohérence du contenu d’assistance de notre base de connaissances. Votre travail de vérification garantit que les utilisateurs et utilisatrices peuvent faire confiance à nos articles et trouver de l’aide facilement.

Responsabilités clés

En tant que vérificateur ou vérificatrice de la base de connaissances, lorsque vous vérifiez une révision, assurez-vous toujours que la révision :

  • Est exacte et à jour
  • Utilise un langage et un ton clairs et cohérents
  • Est conforme aux directives éditoriales de Mozilla
  • Comprend une mise en forme, des liens et un balisage corrects et fonctionnels
  • Respecte les bonnes pratiques en matière d’accessibilité et de localisation
  • Respecte le périmètre de l’article et la version du produit

Directives de vérification

Note : ces directives d’approbation ne s’appliquent qu’à la vérification des mises à jour en anglais américain (en-US). Elles ne s’appliquent pas aux mises à jour traduites, non en-US. Pour plus d’informations sur la localisation de contenu, consultez l’article Translating an article.

Beaucoup de révisions sont faites par des bénévoles mettant à disposition leur temps et leur talent. Lorsque vous discutez du travail que ces personnes ont soumis, supposez que tout le monde a les meilleures intentions et n’oubliez pas de les remercier pour leur contribution. Rappelez-vous, vous pouvez être le premier et le seul contact que cette personne a avec quelqu’un de Mozilla. Veuillez faire en sorte qu’il soit positif.

Politique de vérification de la base de connaissances

Pour les mises à jour majeures, il est important de faire la distinction entre l’approbation du contenu et la vérification du contenu, car il s’agit de deux processus distincts.

  • L’approbation du contenu est effectuée par les parties prenantes du produit principalement pour valider l’exactitude technique du contenu.
  • La vérification du contenu est effectuée par les vérificateurs et vérificatrices de la base de connaissances pour garantir la qualité éditoriale et la mise en forme de l’article.

Pour plus de détails sur cette distinction, consultez cette section d’article.

Quand la vérification par le personnel est-elle requise ?

La vérification par le personnel est requise pour :

  • Les nouveaux articles
  • Les mises à jour majeures explicitement marquées « Vérification par le personnel requise » dans les notes de révision

Quand les contributeurs et contributrices avec les permissions de vérification de la base de connaissances peuvent-ils vérifier les révisions ?

Important ! Aucune autoapprobation par un contributeur ou une contributrice n’est autorisée pour aucun type de révision.

Les contributeurs et contributrices disposant des permissions de vérification de la base de connaissances peuvent vérifier :

  • les révisions classées comme modifications mineures
  • les modifications majeures qui ne nécessitent pas de vérification par le personnel

Consultez l’article Modifications mineures et majeures pour en savoir plus sur la façon dont les mises à jour de contenu sont classées en fonction de leur portée et de leur impact.

Note : toutes les révisions avec des mises à jour majeures doivent être accompagnées d’un ticket de demande de contenu sur Bugzilla. Si vous voyez une mise à jour majeure sans ticket Bugzilla, en tant que vérificateur ou vérificatrice de la base de connaissances, vous pouvez contacter la personne autrice de la révision pour demander qu’un ticket Bugzilla soit créé.

Où trouver les articles non vérifiés

Il existe plusieurs façons de trouver des articles non vérifiés :

  • Aperçu de la base de connaissances : cette page vous fournit une liste d’articles par ordre de nombre de vues au cours des 30 derniers jours. La colonne « Status » (état) indique les articles qui nécessitent une vérification. Vous pouvez également filtrer par produit et par type d’article.
  • Modifications non vérifiées : cette page offre une autre façon de voir quels articles nécessitent une vérification, ainsi que depuis combien de temps chaque révision attend d’être vérifiée. Vous pouvez choisir de trier en fonction du nombre de vues ou des modifications les plus récentes. Vous pouvez également filtrer par produit.
  • Les plus consultés : cette page vous fournit une liste d’articles de la base de connaissances en fonction du nombre de vues. Dans la colonne « Status » (état), vous pouvez voir les articles qui nécessitent une vérification.

Priorisation

Lors de la vérification de plusieurs articles, il est important de prioriser vos efforts de manière stratégique. Tenez compte des éléments suivants :

  • Article avec un grand nombre de vues : les articles avec un grand nombre de vues doivent être priorisés pour garantir que les utilisateurs et utilisatrices accèdent aux informations les plus exactes et les plus à jour. Vous pouvez facilement les identifier en triant la liste des modifications non vérifiées par nombre de vues.
  • Article lié dans le produit : si vous faites partie de l’un des groupes de contribution (Forum, KB, L10n) ou du groupe du personnel (Staff), vous pouvez voir un indicateur montrant qu’un article est lié dans le produit. Ces articles doivent généralement être prioritaires, car ils ont un impact direct sur l’expérience utilisateur.
  •  ;in-product KB indicator

Articles spéciaux

  • Les modèles (templates) incluent du contenu réutilisé dans plusieurs articles et doivent être considérés comme hautement prioritaires en raison de leur impact plus large. Tous les modèles, y compris ceux qui nécessitent une vérification, sont listés dans ce tableau de bord. Pour des directives sur la façon d’utiliser les modèles dans les articles, veuillez vous référer à l’article Comment utiliser les modèles.
  • Les réponses types (canned responses) sont des réponses standardisées utilisées dans les forums de la communauté. Comme elles sont fréquemment réutilisées, toute mise à jour doit être coordonnée avec l’équipe Community. Une liste de toutes les réponses du forum, y compris celles qui nécessitent une vérification, est disponible dans cet autre tableau de bord. Pour des directives supplémentaires sur la création ou l’amélioration des réponses courantes, consultez l’article Créer ou améliorer les réponses courantes du forum.

Exigences spéciales pour les produits sur abonnement ou premium

Soumission de contenu

Important ! Les contributeurs et contributrices ne peuvent pas soumettre directement de mises à jour ou créer de nouveaux articles de la base de connaissances pour les produits sur abonnement ou premium.

Si vous souhaitez suggérer du nouveau contenu ou proposer des modifications, veuillez ouvrir un ticket Bugzilla ou contacter un membre du personnel. Vous pouvez nous contacter soit sur Matrix, soit dans le canal #sumo-team sur Slack (pour les contributeurs et contributrices ayant accès à Slack).

Vérification et approbation des révisions de la base de connaissances

L’approbation par le personnel est requise pour toutes les révisions relatives aux produits sur abonnement ou premium, y compris les réponses types et les modèles associés à ces produits.

Pour référence, les produits sur abonnement ou premium actuels incluent :

  • Mozilla VPN
  • Firefox Relay
  • Mozilla Monitor
  • MDN Plus

Vérification d’articles

Choisir les niveaux de révision

Lorsque vous approuvez un article, vous avez le choix entre trois niveaux de révision différents. Ces niveaux détermineront le besoin et la priorisation de la localisation.

  • Détails mineurs qui n’affectent pas les instructions : ce sont des changements qui ne modifient pas les instructions pour les utilisateurs et utilisatrices. Les équipes de localisation ne seront pas informées de ces changements.
  • Modifications de contenu qui ne nécessitent pas une traduction immédiate : c’est le choix par défaut. Ce sont des changements majeurs (mises à jour et gros changements) qui n’invalident pas complètement la version précédente de l’article. Les équipes de localisation ne sont pas informées immédiatement des changements, mais la révision peut être marquée comme prête pour la localisation plus tard, ce qui déclenche alors une notification à leur intention.
  • Modifications majeures de contenu qui rendront les anciennes traductions inexactes : ce niveau peut être utilisé lorsque la mise à jour rend le contenu précédent obsolète. Le marquer ainsi déclenche un avertissement sur les articles localisés indiquant que le contenu peut être obsolète et fournit un lien vers la version anglaise pour les informations les plus à jour.
    Revision level updated

Laisser des commentaires aux rédacteurs et rédactrices

Lorsque vous approuvez un article, il est important de remercier les rédacteurs et rédactrices pour leur contribution. Il est également agréable de pouvoir leur faire un retour. Leur écriture s’est-elle améliorée ? Ont-ils fait un travail particulièrement bon pour expliquer quelque chose de complexe ? Faites-le leur savoir !

Note : si une révision est bonne mais contient une erreur mineure (faute de frappe, erreur de balisage, etc.), vous pouvez l’approuver et demander au rédacteur ou à la rédactrice de corriger le problème. Sinon, vous pouvez également soumettre une nouvelle révision pour le corriger et demander de la vérifier à une autre personne disposant de droits de vérification de la base de connaissances.
editor feedback

Ajourner une révision

Si une révision n’est pas particulièrement utile, vous pouvez ajourner la révision proposée. Plutôt qu’un simple rejet, cependant, un ajournement est votre occasion de travailler avec l’auteur ou l’autrice de la révision pour l’améliorer. Vous pouvez le faire en laissant un message dans le champ de commentaire pour remercier l’auteur ou l’autrice, puis donner des commentaires spécifiques et constructifs sur ce qui, selon vous, doit changer pour que la révision soit acceptable. Assurez-vous d’inclure également des liens vers toute documentation ou directive pertinente.

kb deferral

Vérifier plusieurs révisions

Lorsqu’il y a plusieurs révisions en attente d’approbation, assurez-vous de vérifier toutes les révisions en commençant par la plus ancienne avant de prendre une décision. Il est important de noter que vous ne pouvez pas vérifier les anciennes révisions lorsqu’une révision plus récente a été approuvée. Elles sont toujours en attente d’approbation, mais il n’est plus possible de les vérifier.

Changements nécessaires

Lors de l’approbation d’une révision, vous devez décider ce qui, le cas échéant, doit encore être changé. Si tout ce qui est spécifié dans le commentaire « Changements nécessaires » a été pris en compte, vous pouvez la décocher (ce qui efface le commentaire) et approuver l’article. S’il y a encore des choses à modifier, assurez-vous que la case est cochée et mettez à jour le commentaire. De cette façon, nous pouvons facilement garder une trace du travail qui reste à faire sur les articles.

Needs change

Reconnaître les contributions

Parfois, les gens qui participent à une discussion sur un article apportent des contributions importantes à une révision, même si ce ne sont pas ceux qui ont réellement modifié le Wiki. Dans de tels cas, vous pouvez modifier la liste des personnes contributrices à un article (sur la page de l’historique de l’article) pour les inclure. Des points de bonus pour leur faire savoir que vous avez fait cela !

Comment reconnaître la contribution d’une personne dans la base de connaissances

  • Pour ajouter un contributeur ou une contributrice, allez à la page Show History (afficher l’historique) d’un article.
  • Faites défiler sous les révisions et cliquez sur le lien Edit contributors (modifier les contributeurs et contributrices).
  • Saisissez le nom du contributeur ou de la contributrice, puis cliquez sur Add Contributor
Note : toute personne ayant soumis une révision est créditée automatiquement, sauf si sa révision est ajournée.

Gérer le spam et les modifications erronées

Dans le cas de spam, vous devriez simplement supprimer la révision en cliquant sur l’icône de corbeille dans l’historique des révisions de l’article et en confirmant. Dans le cas de soumissions erronées (aucun changement) et de demandes d’aide mal placées (la modification est essentiellement une question d’assistance), vous devriez l’ajourner et inclure ce message dans votre commentaire :
Hi.
It appears you may have been trying to get help with Firefox. If that is the case, please ask your question again here, https://support.mozilla.org/questions/new so that we can better help you.
Sorry for the inconvenience.

Une fois que vous avez fait cela, vous pouvez supprimer la révision.

DeleteKBspam

Note : vous ne pouvez pas supprimer un article non approuvé qui est un spam ou une demande d’assistance en supprimant ses révisions. Signalez ces articles à un administrateur ou à une administratrice.

Prêt pour la localisation

Comment fonctionne « Prêt pour la localisation » (RFL) ?

Pour empêcher les contributeurs et contributrices de traduire un article qui est encore en cours de mise à jour, le système n’autorise la traduction que des versions qui ont été explicitement marquées comme prêtes pour la localisation (RFL). Lorsque la personne qui localise clique sur Translate article (traduire l’article), la révision la plus récente marquée comme RFL lui est proposée.

Après l’approbation d’une nouvelle révision, l’article n’apparaît plus dans les tableaux de bord de localisation comme nécessitant une mise à jour, à moins que l’indicateur Prêt pour la localisation (RFL) ne soit activé. Lorsque l’indicateur RFL est défini, le système envoie également une notification par e-mail à toutes les personnes qui suivent l’article, les informant qu’il est prêt à être localisé.

Marquer un article comme RFL

Marquer une révision d’article comme « prête pour la localisation » signifie que nous disons aux équipes de localisation que la version anglaise est terminée et peut être traduite sans craindre que l’article ne change encore plusieurs fois avant qu’elles aient fini.

RFL update
Note : la colonne Ready for L10N (prêt pour la localisation) du tableau de bord de la base de connaissances indique Non pour les articles avec des modifications de contenu approuvées qui n’ont pas été marquées comme prêtes pour la localisation. Ces articles seront également listés sur la page Modifications non prêtes pour la localisation.

La localisation demande beaucoup de travail et est souvent effectuée par une seule personne. Ce n’est pas toujours facile, mais essayez de vous assurer que toutes les modifications requises sont effectuées avant une version de Firefox afin que les équipes de localisation puissent utiliser ce temps supplémentaire pour faire leur travail.

Note : n’oubliez pas que si vous marquez une révision comme une mise à jour mineure, il n’y a pas d’option pour marquer l’article comme prêt pour la localisation, car les équipes de localisation ne sont pas informées des changements avec ce niveau de révision.

Marquer un article comme RFL après la vérification

Si vous ne marquez pas une révision comme prête pour la localisation lors de son approbation (comme dans le cas ci-dessus), vous pouvez la marquer comme prête à tout moment en cliquant sur l’entrée d’état Not ready for localization (non prête pour la localisation) (un symbole ) sous la colonne R de l’historique des révisions de l’article et en confirmant.

ReadyForLocalization3

Les révisions qui ont été marquées RFL ont un symbole de coche

Protocoles RFL

Tous les vérificateurs et toutes les vérificatrices bénévoles doivent adhérer aux protocoles de localisation suivants :

  • Tout le personnel de Mozilla, toutes les personnes bénévoles disposant de droits de vérification peuvent marquer un nouvel article ou une mise à jour d’article comme prêt pour la localisation.
  • Tous les nouveaux articles et toutes les révisions qui introduisent des informations nouvelles ou modifiées doivent être marqués pour la localisation, sauf indication contraire des équipes produit en fonction de la disponibilité locale.
  • Si une révision ne modifie pas les instructions, l’exactitude ou l’expérience utilisateur, la priorité de localisation doit être diminuée en conséquence.
  • Dans certains cas, le personnel de Mozilla peut laisser une syntaxe de commentaire ou un commentaire de révision dans un article pour indiquer qu’une traduction est déjà soumise pour une localisation interne dans certaines langues. Si la syntaxe de commentaire indique qu’un article ou une révision est déjà soumis pour une localisation interne, les contributeurs et contributrices ne doivent pas le localiser de manière indépendante.

Préparation des versions

Pour nous assurer que tout est prêt pour prendre en charge les prochaines versions de Firefox, voici quelques directives concernant les délais de préparation des versions. Les articles associés à la prochaine version sont soit de nouveaux articles, soit des mises à jour de contenu qui couvrent les fonctionnalités introduites dans la prochaine version. Les directives suivantes s’appliquent aux articles dont le contenu est lié à la version.

Calendrier des versions de Firefox

Note : vous pouvez trouver un calendrier des versions de Firefox ici.

4 semaines avant la prochaine version

  • Commencer la planification et la rédaction du contenu pour la prochaine version ; pas encore de travail pour les équipes de localisation.
  • Tous les articles existants restent ouverts à la modification et à la localisation comme d’habitude.

1-2 semaines avant la prochaine version

  • Le brouillon du contenu pour la prochaine version peut être prêt en interne ; cependant, la publication attend généralement la date de sortie officielle pour tenir compte des changements de dernière minute.
  • Si le contenu nécessite une localisation avant la sortie, l’équipe produit doit en informer le personnel de l’expérience client (CX) afin que nous puissions nous coordonner avec la communauté de localisation pour garantir le respect des délais.

Jour de la sortie

  • Les modifications de contenu doivent être publiées dans la base de connaissances en-US. Les équipes de localisation doivent prioriser la traduction des articles liés à la nouvelle version.

Canal de discussion et escalade

Tous les vérificateurs et toutes les vérificatrices de la base de connaissances ne surveillent pas activement les discussions de la base de connaissances. Si vous avez besoin de joindre l’ensemble du groupe des vérificateurs et vérificatrices de la base de connaissances, envoyez un e-mail à kb-reviewers@mozilla.com.

Évaluation du rôle

Créer un contenu précis, cohérent et pertinent est important, et maintenir cette qualité au fil du temps nécessite des normes communes et un alignement continu.

En tant que vérificateur ou vérificatrice de la base de connaissances, vous jouez un rôle important dans le respect de ces normes. Pour garantir que notre groupe de vérificateurs et vérificatrices reste actif et aligné sur les pratiques actuelles, l’équipe de la communauté effectue une légère évaluation annuelle basée sur la participation et le respect des directives.

Pour conserver votre permission de vérification de la base de connaissances, nous vous demandons de :

Si vous n’avez pas été actif ou active ou si des questions se posent sur le respect des directives, l’équipe de la communauté peut vous contacter pour faire le point avant de prendre toute mesure. Notre objectif n’est pas de supprimer des permissions, mais de nous assurer que les vérificateurs et vérificatrices se sentent engagés, soutenus et alignés sur les processus actuels.

Si les circonstances changent et que vous devez prendre du recul, nous comprenons tout à fait. Comme il s’agit d’un rôle bénévole, votre temps et votre disponibilité peuvent naturellement changer. N’hésitez pas à en informer l’équipe de la communauté lorsque cela se produit. Nous nous ferons un plaisir de reprendre contact dès que vous vous sentirez d’attaque pour vous réimpliquer.

En travaillant ensemble et en impliquant d’autres personnes dans le processus de vérification et d’approbation, nous pouvons maintenir les normes de qualité les plus élevées et nous assurer que notre contenu est de premier ordre. Merci de votre coopération et continuons à créer des révisions exceptionnelles pour nos utilisateurs et utilisatrices !

Ces personnes ont aidé à écrire cet article :

Illustration of hands

Participer

Développez et partagez votre expertise avec les autres. Répondez aux questions et améliorez notre base de connaissances.

En savoir plus