Compare Revisions

Comment la base de connaissances de l’assistance de Mozilla (SUMO) fonctionne.

Découvrez la base de connaissances de l’assistance de Mozilla (SUMO) et son fonctionnement. __TOC__ = La base de connaissances est un wiki avec des super-pouvoirs = *'''Balises wiki spéciales''' – Bien que nous utilisions les balises MediaWiki (comme Wikipédia) pour la plupart des choses, notre wiki est conçu spécifiquement pour l’assistance de Mozilla et utilise des balises personnalisées (appelées [[How to use For|<nowiki>{</nowiki>for}]]) afin que nous puissions montrer des instructions aux personnes utilisant Windows, par exemple, et d’autres à celles utilisant un Mac. *'''Système de vérification''' – Parce que nous voulons être sûrs que les gens ont des informations correctes et à jour, les modifications apportées à nos articles doivent être vérifiées et approuvées avant qu’elles ne soient mises en ligne. *'''Traductions''' – La plupart de nos utilisateurs parlent une autre langue que l’anglais. Nous disposons d’un système complet de traduction des articles de notre base de connaissances en anglais vers d’autres langues. = Public et périmètre de la base de connaissances = Comme les [https://support.mozilla.org/products logiciels de Mozilla] sont utilisés par des millions de personnes de tous niveaux de compétence, la base de connaissances doit être écrite pour un large public plutôt qu’un très familier avec les techniques et la terminologie informatiques. Nous couvrons principalement les fonctionnalités (comme les onglets, les marque-pages et la synchronisation) et la correction de problèmes (comme les plantages ou les problèmes de chargement de sites web). Nous ne couvrons pas toutes les fonctionnalités, tous les paramétrages ou problèmes. Nous regardons plutôt ce que les utilisateurs et utilisatrices nous disent (dans les discussions des articles, dans les forums d’assistance et en étudiant le nombre de visites des articles) et utilisons notre expérience et notre jugement pour décider exactement quoi traiter. '''Quels sujets ne couvrons-nous pas dans la base de connaissances ?''' *Les astuces ou bidouillages pour modifier un produit. *Les fonctionnalités avancées et destinées aux développeurs et développeuses comme la console d’erreurs et la console web. {note}'''Note''' : les articles de résolution des problèmes sont souvent une exception à ces règles. Si un problème courant ne peut être corrigé qu’avec un « bidouillage », nous le documentons Ces règles ne s’appliquent pas aux articles pour [/products/firefox-enterprise Firefox pour entreprise] qui sont rédigés pour les administrateurs et administratrices informatiques qui veulent paramétrer Firefox sur les ordinateurs de leur organisation.{/note} = Organisation de notre travail = == Comment gérons-nous nos priorités ? == '''Nous travaillons principalement sur les articles en fonction de leur popularité.''' Cela représente généralement les priorités de nos utilisateurs et utilisatrices. Actuellement, les [/contributors/most-visited vingt articles les plus vus] comptent pour moitié de toutes les visites. Améliorer nos articles les plus vus peut potentiellement aider autant de personnes que l’amélioration des cent articles les moins vus. Nous gardons une trace des changements à réaliser dans [/contributors/need-changes ce tableau de bord]. Il est trié en fonction du rang des articles afin que vous puissiez aisément voir ceux sur lesquels il faudrait travailler en premier. <br> '''Exceptions :'''<br> Bien évidemment, la popularité n’est pas la seule priorité. Ces exceptions ont également besoin d’être prises en compte.<br> *'''Nouveaux problèmes''' – Occasionnellement, de nouveaux problèmes sont signalés dans notre forum d’assistance qu’il est préférable de traiter en mettant à jour un article de la base de connaissances. Par exemple, un problème affectant les personnes utilisant le [[Flash Plugin - Keep it up to date and troubleshoot problems|plugin Flash]] (la plupart de ceux et celles qui utilisent Firefox) serait plus important à mettre à jour qu’une fonctionnalité existante dans une version à venir de Firefox. *'''Demande anticipée''' – Occasionnellement, nous mettrons à jour un article en anticipation d’une nouvelle fonctionnalité ou d’une fonctionnalité modifiée. L’article actuel peut ne pas avoir un rang particulièrement élevé, mais nous sommes raisonnablement sûrs, en nous fondant sur l’expérience et les plans marketing, que ces articles deviendront populaires. *'''Documentation pour mobile''' – Parce que les produits de Mozilla pour appareils mobiles tels que Firefox pour Android et Firefox pour iOS ont comparativement peu d’utilisateurs, leurs articles ne peuvent « concourir » avec les articles pour Firefox pour ordinateur. Les articles pour ces produits devraient être considérés dans le contexte de la demande relative de documentation de fonctionnalités et problèmes. *'''Articles liés''' – Ce sont les articles vers lesquels un lien figure dans les produits ou sur mozilla.org. <!-- Needs review and update for current process (Are we still doing this?) '''Localisation :'''<br> Afin de minimiser le travail pour les localisateurs, notre objectif est d’avoir des mises à jour des 20 articles les plus vus faites toutes les six semaines. Les mises à jour non essentielles (nouvelles fonctionnalités, corrections mineures et améliorations) à ces articles sont faites en anglais, mais non marquées comme prêtes pour la localisation immédiatement. Quatre semaines avant une sortie de produit, nous marquerons les changements à ces articles prêts pour la localisation. Nous essaierons de garder ces articles stables pour les six semaines suivantes. Parfois, des nouveaux problèmes ou des erreurs peuvent nous obliger à changer à nouveau les articles. Toutes les six semaines environ, nous créons une liste de priorités ([/forums/l10n-forum/708538 exemple]) comme ligne directrice pour les localisateurs et localisatrices en fonction de notre expérience avec l’anglais. --> == Où parlons-nous des articles ? == Nous avons généralement deux types de conversations sur les articles de la base de connaissances :<br> *'''Articles individuels''' – Chaque article a son propre onglet de discussion. Les utilisateurs et utilisatrices enregistrés peuvent y publier des retours sur les articles. Nous pouvons y discuter des révisions dont l’article a besoin, des mérites relatifs de chaque révision et des problèmes liés à l’article.<br>[[Image:New Article Discussion]] *'''La base de connaissances en anglais comme un tout''' – Nous discutons des idées et problèmes avec la stratégie globale de la base de connaissances, des politiques et des logiciels dans le '''[/forums/knowledge-base-articles/ forum des articles (en anglais)]'''. <!--Needs review and update for current process (Are we still doing this?) == Comment gardons-nous les articles à jour avec la dernière version des produits Mozilla ? == Il y a de nombreuses versions de produits de Mozilla qui sont générés en même temps. Nous les appelons des « trains ». Chaque train se déplace d’un canal (ou voie pour poursuivre la métaphore du train) toutes les six semaines. Nous avons les canaux Nightly, Aurora, bêta et finale. Durant six semaines, de nouvelles fonctionnalités et des corrections sont ajoutées à ces logiciels lorsqu’ils sont dans le canal Nightly. Ensuite, cette version se déplace vers le canal Aurora pour des essais. Après six semaines sur Aurora, elle se déplace vers la bêta. Puis finalement, après six semaines d’essais en bêta, cette version devient la version finale du logiciel. Afin de suivre l’évolution des produits, l’écriture de notre documentation suit également un cycle de six semaines. [[Image:doc schedule]] === Cycle de documentation des semaines 1 à 4 === *'''Localiser la bêta''' : Une fois les articles finalisés (dans le cycle précédent), il y a quatre semaines pour les localiser avant la sortie en version finale. Les révisions seront marquées par un administrateur comme prêtes pour la localisation afin qu’elles s’affichent sur les tableaux de bord de localisation. **'''Note :''' dans les deux semaines précédentes, des mises à jour basées sur des retours de la dernière version seront aussi incluses dans ce lot d’articles à localiser. *'''Rédiger Aurora''' : Durant ces quatre semaines, nous rédigeons de nouveaux articles en anglais ou mettons à jour des articles en anglais existants. Nous surveillons la page de '''[https://wiki.mozilla.org/Features/Release_Tracking suivi des nouvelles fonctionnalités (en anglais)]''' pour identifier les changements et ajouts que nous devons documenter. *'''Suivre Nightly''' : Nous surveillons la page de '''[https://wiki.mozilla.org/Features/Release_Tracking suivi des nouvelles fonctionnalités (en anglais)]''' pour identifier les changements et ajouts que nous devons documenter. Le suivi des nouvelles fonctionnalités de Firefox est un processus continu qui se poursuit lors de sa phase bêta, mais après le passage en Aurora, les seuls changements principaux possibles ne devraient être que la suppression d’une fonctionnalité. *'''Archiver''' : Puisque nos produits, nos services et notre documentation évoluent à chaque nouvelle version, nous mettons à profit ce temps pour évaluer s’il y a des articles qui sont : **obsolètes car nos produits et services ont changé ; **obsolètes car ils reçoivent si peu de visites que ce n’est pas une préoccupation de la majeure partie des utilisateurs et utilisatrices. === Cycle de documentation des semaines 5 et 6 === *'''Mettre à jour la version finale''' : Une nouvelle version des produits Mozilla sera à peine sortie donc, si nécessaire, nous serons en mesure de revenir faire des ajustements basés sur les retours laissés dans les forums d’assistance. *'''Finaliser la bêta''' : Une fois Aurora passé en bêta, nous aurons deux semaines pour finaliser les articles en anglais qui ont été préalablement esquissés. Pendant cette période, nous : ** ajouterons des captures d’écran et captures vidéo d’écran, si nécessaire ; ** vérifierons et approuverons les articles en anglais ; ** marquerons la révision finale comme '''[[#w_praet-pour-la-localisation|prête pour la localisation]]'''. *'''Commencer le suivi de la nouvelle version Nightly''' : Une nouvelle version sera désormais sur le canal Nightly. --> == Comment puis-je rester au courant de ce qui se passe ? == *'''[http://blog.mozilla.org/sumo Blog de l’assistance de Mozilla (SUMO) (en anglais)]''' : les dernières mises à jour et derniers développements y sont discutés. *'''[[Contributor News & Resources]]''' : c’est une autre bonne source d’information – elle est mise à jour chaque semaine environ. *'''[/forums/contributors Forum de discussion de la communauté SUMO (en anglais)]''' : c’est là où les contributeurs discutent entre eux. *'''[/forums/knowledge-base-articles Forum des articles de la base de connaissances (en anglais)]''' : c’est l’endroit où nous discutons des sujets généraux concernant la base de connaissances. *'''[/forums/l10n-forum Forum de la traduction (en anglais)]''': c’est là où nous parlons de la localisation de SUMO. = Améliorer les articles en anglais = '''L’amélioration des articles de la base de connaissances en anglais occupe probablement 90 % de notre temps.''' Il y a toujours quelque chose qui peut être amélioré. Voici trois principales façons d’améliorer un article : *'''Garder les articles à jour''' – Les mises à jour majeures des produits et services de Mozilla apportent toujours de nouvelles fonctionnalités et des changements de la manière dont celles existantes fonctionnent. Il est toujours mieux que nos instructions correspondent à la manière dont les choses fonctionnent dans le produit. *'''Relire''' – Certains d’entre vous ont de super-pouvoirs pour mettre en évidence les erreurs que les correcteurs orthographiques n’ont pas repérées (combien en avez-vous noté dans cet article jusqu’à maintenant ?). Nous avons besoin de votre aide. **Corrigez l’orthographe, la grammaire et la ponctuation. **Corrigez les problèmes de style et de formatage. Consultez '''[[How to write Knowledge Base articles]]''', '''[[How to use For]]''' et '''[[How to use Templates]]''' pour des directives. *'''Rendre les articles plus faciles à comprendre''' **Trouvez un meilleur moyen d’expliquer une chose trop complexe ou pas vraiment claire. **Ajoutez des captures d’écran pour aider les gens à comprendre à quoi se réfère l’article. La plupart des gens ne connaissent probablement pas la différence entre la barre d’adresse et la barre de recherche, ou toute autre barre à moins qu’elle ne soit en chocolat. **Ajoutez des captures vidéo d’écran. C’est bien mieux de montrer à quelqu’un comment faire une chose plutôt que de lui décrire. == Quel est le processus pour modifier un article en anglais ? == Au minimum, tout ce que vous avez à faire est de cliquer sur {button Edit Article}, d’apporter quelques changements et de les soumettre à vérification. Le processus complet ressemble à ceci : # Rendez-vous sur la [/contributors/need-changes section des modifications planifiées du tableau de bord des contributeurs]. # À partir des commentaires qui décrivent les modifications à réaliser, choisissez un article. Cliquez sur {button Editing Tools} et jetez un œil à la discussion afin d’avoir des informations pertinentes sur les modifications programmées. # Modifiez l’article. Consultez [[How to write knowledge base articles]] pour les conseils de style. #* Utilisez le bouton {button Preview Content} pour vérifier vos changements. # Cliquez sur le bouton {button Submit for Review} pour enregistrer vos changements. Votre modification sera listée dans la [/contributors/unreviewed section des modifications non vérifiées du tableau de bord des contributeurs]. Si la vérification se fait trop attendre, vous pouvez contacter en anglais @jsavage:mozilla.<!-- -->org dans le [https://chat.mozilla.org/#/room/#SUMO:mozilla.org salon SUMO sur Matrix] ou par [mailto:jsavage@mozilla.com courrier électronique]. Si le vérificateur n’approuve pas l’article, il indiquera ses raisons et commentaires dans un fil de la page de discussion de l’article. Parfois, il crée une nouvelle révision basée sur la vôtre et ajoute ou change des choses. Vous (ou quelqu’un d’autre) peut créer une autre révision et apporter davantage de modifications. Cela prend généralement plusieurs itérations pour que les choses deviennent correctes. == Créer un nouvel article en anglais == Si vous pensez qu’il y a un article que nous avons besoin d’ajouter à la base de connaissances, voici comment procéder. {note}Assurez-vous de rechercher préalablement dans la base de connaissances s’il existe déjà un article sur le sujet que vous voulez documenter.{/note} #'''[/en-US/kb/new Créez un nouvel article]''' et remplissez le formulaire en utilisant la source d’un autre article comme guide. #Rédigez le contenu de l’article. #Vérifiez votre travail en utilisant le bouton {button Preview Content} #Cliquez sur le bouton {button Submit for Review} et décrivez dans le commentaire la raison pour laquelle rédiger l’article. #*Faire ceci ajoute l’article au tableau de bord de la base de connaissances pour faire savoir à tous que l’article est en attente de modification ou de vérification. #*L’article ne sera pas rendu public tant qu’il n’aura pas été vérifié et approuvé. == Style == '''Nous voulons que l’aide de Mozilla soit utilisable par tous les utilisateurs et toutes les utilisatrices. Cela signifie que nous écrivons pour un large public plutôt que pour un public très familier avec les techniques et la terminologie informatiques.''' * La personne pour qui vous écrivez ne sait pas comment changer les préférences ou ajouter un bouton de barre d’outils sans des instructions pas à pas. * Supposez que les personnes n’ont changé aucun des paramètres par défaut du produit ou du système d’exploitation. * Style d’écriture conversationnel – Utilisez un style informel et actif semblable à la manière dont vous parleriez en personne à quelqu’un. * Images et vidéos – L’utilisation des images et vidéos en parallèle du texte pour expliquer les choses est un moyen facile d’inclure les multiples styles d’apprentissage et de répétition. Pour davantage d’informations, consultez '''[[How to write Knowledge Base articles]]'''. == Balises == Notre Wiki utilise la syntaxe MediaWiki avec quelques particularités ajoutées pour styliser les boutons, touches, menus, etc. Consultez '''[[Markup chart]]''' pour une liste et des exemples. ==<nowiki>{</nowiki>for<nowiki>}</nowiki>== '''[[How to use For]]''' contient des procédures et des exemples pour afficher et masquer les instructions pour des versions différentes de Firefox et différents systèmes d’exploitation. ==Modèles== Nous avons une liste de [/kb/category/60 modèles] que nous utilisons dans les articles afin que les mêmes séries d’instructions ne soient pas réécrites, localisées et gardées synchronisées dans de nombreux articles. '''[[How to use Templates]] '''explique la manière dont cela fonctionne. ==Captures d’écran et captures vidéo d’écran == '''Nous devons nous assurer que les articles sont écrits pour être compréhensibles sans images ou vidéos.''' Bien que les images et vidéos soient importantes et augmentent grandement l’utilité d’un article, elles ne peuvent être obligatoires. Les localisateurs et localisatrices ne doivent pas hésiter à les utiliser ou les supprimer comme bon leur semble. '''Priorité sur la version pour ordinateur''' #'''Windows''' – avec environ 90 % de nos utilisateurs et utilisatrices sous Windows, il n’y a pas à réfléchir. À partir de maintenant, nous devons faire des captures d’écran de Windows 7 ou supérieur si on ne peut en faire qu’une. #'''Mac''' – la version actuelle est macOS 10.14 (Mojave). #'''Linux''' – utilisez Ubuntu pour les captures d’écran. '''Mobile''' #'''Android''' – 4.0 + (4.0, 4.1, 4.2, 4.3, etc.). =Ajouter ou supprimer des articles en anglais= ==Proposer de nouveaux articles en anglais== Notre base de connaissances est ce qui constitue entièrement notre démarche d’assistance, dimensionnée pour servir des centaines de millions d’utilisateurs et utilisatrices de Firefox. Le mieux que nous puissions faire est de répondre aux questions posées sur les produits et services de Mozilla par un article. Mais les articles ont tous un coût. Chacun doit être écrit, localisé et maintenu. Avec beaucoup de fonctionnalités et de problèmes déjà documentés, notre temps à tous et toutes est mieux dépensé à améliorer les articles existants. Avant de commencer à créer de nouveaux articles, réfléchissez aux choses suivantes : '''Avons-nous réellement besoin de cet article ?'''<br> Voici les raisons principales d’ajout d’un nouvel article à la base de connaissances, même s’il est souvent plus logique de mettre à jour un article existant. *'''Nouvelles fonctionnalités''' – Fonctionnalités visibles susceptibles de générer beaucoup d’intérêt et de questions de la part des utilisateurs et utilisatrices. Il peut s’agir d’un aspect inhérent à la fonctionnalité, du résultat de liens marketing ou inclus dans les produits, ou d’une combinaison des deux. *'''Nouveaux problèmes''' – Problèmes remontés dans de nombreux fils de discussion avec beaucoup de votes dans le forum d’assistance. *'''Impact élevé''' – Problèmes critiques devant être rapidement et temporairement documentés (p. ex. [[Firefox startup crash with G DATA security software]]). ==Archiver les articles== '''Nous archiverons périodiquement des articles de la base de connaissances pour nous concentrer sur les sujets les plus pressants pour les utilisateurs et utilisatrices.''' Puisque nous sortons une nouvelle version des produits Mozilla toutes les six semaines, les problèmes et sujets pour lesquels les utilisateurs et utilisatrices ont besoin de documentation changent à un rythme plus rapide. Il y a beaucoup d’articles, comme [[Create bookmarks to save your favorite webpages]] ou [[How to set the home page]], qui resteront pendant longtemps, mais il y en aura d’autres qui deviendront obsolètes ou plus une préoccupation pour les utilisateurs et utilisatrices. '''Comment cela fonctionne :'''<br> Les contributeurs ou contributrices avec des droits de vérification peuvent marquer un article comme obsolète en modifiant la section de description d’un article. Cela supprimera l’article de tous les tableaux de bord, notamment les tableaux de bord de localisation, et des recherches standards. Vous pouvez toujours voir l’article en utilisant la recherche avancée, et bien sûr, les liens vers l’article seront préservés. Néanmoins, il y aura un avertissement en haut de l’article indiquant qu’il n’est plus maintenu et donc possiblement plus à jour. Archiver un article n’est pas à sens unique. Une fois qu’un article est archivé, nous surveillerons les statistiques pour nous assurer qu’il n’a pas reçu de nombreuses visites. Si nous nous sommes trompés, un simple clic dans une case permet de faire réapparaître l’article dans les tableaux de bord. '''Éléments à considérer avant d’archiver un article :'''<br> *'''Peu de vues''' – Généralement, les articles avec environ moins de mille cinq cents visites par mois. *'''Peu de retours récents''' – Problèmes qui ont relativement peu de fils de discussion récents avec votes dans le forum d’assistance. *'''Peu d’impact''' – La suppression de l’article est peu susceptible de causer ou d’aggraver un problème sérieux. *'''Changements dans les produits et services''' – Cas où un problème a été corrigé ou un changement dans le comportement a rendu quelque chose obsolète. =Directives pour la vérification des articles en anglais = Pour connaître les directives pour vérifier les articles de la base de connaissances, voir les [[Article review guidelines|directives pour la vérification des articles en anglais]].