Comment la base de connaissances fonctionne

D'accord. Voici la version longue sur la manière dont les choses fonctionnent. Prenez le temps de prendre une collation avant de commencer. Même la table des matières est longue.

La base de connaissances est un Wiki avec des super pouvoirs

Visez cela :

  • Balises Wiki spéciales - Bien que nous utilisions les balises MediaWiki (comme Wikipedia) 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 {for}) afin que nous puissions montrer des instructions aux utilisateurs Windows, par exemple, et d'autres aux utilisateurs 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 langue autre que l'anglais. Donc, nous avons un système complet de traduction vers d'autres langues des articles de notre base de connaissances en anglais.

Public et périmètre de la base de connaissances

Avec plus de quatre cent millions d'utilisateurs de Firefox, la base de connaissances doit être écrite pour un public large 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 corrections des 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 nous disent (dans les discussions d'article, les forums d'assistance, avec le nombre de visites d'articles) et utilisons notre expérience et notre jugement pour décider exactement de ce que nous traitons.

Quels sujets ne couvrons-nous pas dans la base de connaissances ?

  • Les astuces ou rustines pour modifier un produit.
  • Les fonctionnalités avancées et destinées aux développeurs comme les consoles d'erreurs et web.
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 une "rustine", nous documenterons cela.

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. Actuellement, les 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 ce tableau de bord. Il est trié par rang d'article afin que vous puissiez aisément voir ceux sur lesquels il faudrait travailler en premier.

Exceptions :
Bien évidemment, la popularité n'est pas la seule priorité. Ces exceptions ont également besoin d'être prises en compte.

  • 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 utilisateurs de Flash (99% des utilisateurs de 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ûr, basé sur l'expérience et les plans mercatiques, que ces articles deviendront populaires.
  • Documentation mobile - Parce que ces produits (Firefox pour Android, Firefox OS) ont comparativement peu d'utilisateurs, leurs articles ne peuvent « concourir » avec les articles de 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 liés depuis les produits ou mozilla.org.

Localisation :
Afin de minimiser le travail pour les localisateurs, notre objectif est d'avoir des mises à jour aux 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 erreurs peuvent nous obliger à changer de nouveau les articles. Toutes les six semaines, nous créerons une liste de priorités (exemple) comme ligne directrice pour les localisateurs, celle-ci étant basée sur notre retour d'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 :

  • Articles individuels - chaque article a son propre onglet de discussion. Les utilisateurs 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.
    New Article Discussion
  • La base de connaissances en anglais comme un tout - nous discutons des idées et politiques en rapport avec la stratégie globale de la base de connaissances, ainsi que des évolutions et bogues du logiciel SUMO apparenté aux articles dans le forum des articles.

Comment gardons-nous les articles à jour avec la dernière version des produits Mozilla ?

Il y a quatre versions de produits Mozilla (Firefox, Firefox pour Android, Firefox OS) 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 sur 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 sur la 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.

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), ils seront localisés par les localisateurs durant les quatre semaines qui suivent. 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 des localisations.
    • Note : Ce lot d'articles à localiser comprendra également les mises à jour basées sur des retours de la dernière version.
  • Rédiger Aurora : Durant ces quatre semaines, nous rédigerons de nouveaux articles en anglais ou mettrons à jour des articles en anglais existants. Nous surveillerons la page de suivi des nouvelles fonctionnalités (en) pour identifier les changements et ajouts que nous devrons documenter.
  • Suivre Nightly : Nous surveillerons la page de suivi des nouvelles fonctionnalités (en) pour identifier les changements et ajouts que nous devrons documenter. Le suivi des nouvelles fonctionnalités de Firefox est un processus continu qui se poursuivra lors de sa phase bêta, mais après le déplacement vers Aurora, les seuls changements possibles ne devraient être que la suppression d'une nouvelle fonctionnalité.
  • Archiver : Puisque nos produits, services et notre documentation évolueront à chaque nouvelle version, nous mettrons à 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.

Cycle de documentation des semaines 5 et 6

  • Mettre à jour la finale : Une nouvelle version des produits Mozilla sera à peine sortie donc, si nécessaire, nous serons en mesure de revenir en arrière pour faire des ajustements basés sur les retours des forums d'assistance.
  • Finaliser la bêta : Une fois Aurora déplacé vers la bêta, nous aurons deux semaines pour finaliser les articles en anglais qui ont été préalablement rédigés. Pendant cette période, nous :
    • ajouterons des captures d'écrans et captures vidéo d'écran, si nécessaire ;
    • vérifierons et approuverons les articles en anglais ;
    • marquerons la révision finale comme prête pour la localisation ;
  • Commencer le suivi de la nouvelle Nightly : Une nouvelle version sera désormais sur le canal Nightly.

Comment puis-je rester au courant de ce qui se passe ?

Améliorer les articles en anglais

L'amélioration des articles de la base de connaissances en anglais occupe probablement 90% de notre temps. Avec environ deux cent articles dans la base de connaissances, il y a toujours quelque chose qui peut être améliorée. Voici trois façons principales 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 modifient la manière dont les 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 des pouvoirs spéciaux pour mettre en évidence les erreurs que les correcteurs orthographiques ont manquées (combien en avez-vous notées dans cet article jusqu'à maintenant ?). Nous avons besoin de votre aide.
  • Rendre les articles plus faciles à comprendre
    • Trouvez un meilleur moyen d'expliquer quelque chose qui est trop complexe ou pas très claire.
    • Ajoutez des captures d'écran pour aider les gens à comprendre à quoi se réfère l'article. La plupart des personnes ne savent probablement pas la différence entre la barre d'adresse, la barre de recherche, la « barre de fer », ou tout autre barre.
    • 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 Edit Article, d'apporter quelques changements et de les soumettre à vérification. Le processus complet ressemble à ceci :

  1. Rendez-vous sur la section des modifications planifiées du tableau de bord des contributeurs.
  2. À partir des descriptifs de modification à réaliser, choisissez un article. Cliquez sur Editing Tools et jetez un œil à la discussion afin d'avoir des informations pertinentes relatives aux modifications programmées.
  3. Modifier l'article. Consultez Comment écrire les articles de la base de connaissances en anglais pour les astuces de style.
    • Utilisez le bouton Preview Content pour vérifier vos changements.
  4. Cliquez sur le bouton Submit for Review pour enregistrer vos changements. Votre modification sera listée dans la section des modifications non vérifiées du tableau de bord des contributeurs.

Si cela prend trop longtemps à vérifier, vous pouvez avertir michaelverdi sur le canal IRC #sumo ou par courriel.

Si le vérificateur n'approuve pas l'article, il indiquera ses raisons et retours dans un fil de la page de discussion pour l'article. Parfois, il créera une nouvelle révision basée sur la votre et ajoutera ou changera des choses.

Vous (ou quelqu'un d'autre) peut créer une autre révision et faire plus de changements. 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 faire.

Recherchez préalablement dans la base de connaissances pour voir s'il y a déjà un article sur le sujet que vous voulez documenter.
  1. Créez un nouvel article et remplissez le formulaire en utilisant les caractéristiques d'un autre article comme guide.
  2. Rédigez le contenu de l'article.
  3. Vérifiez votre travail en utilisant le bouton Preview Content.
  4. Cliquez sur le bouton Submit for Review et décrivez la raison du besoin de l'article dans le commentaire.
    • Faire ceci ajoute l'article au tableau de bord de la base de connaissances pour faire savoir aux gens 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. Cela signifie que nous écrivons pour un public large plutôt qu'un 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 la répétition.

Pour en savoir plus, consultez Comment écrire les articles de la base de connaissances en anglais.

Balises

Notre Wiki utilise une syntaxe MediaWiki avec des choses additionnelles pour les styles des boutons, touches, menus, etc. Consultez Tableau de balisage pour une liste et des exemples.

{for}

Comment utiliser 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 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 synchronisées dans de multiples articles. Comment utiliser les modèles explique la manière dont cela fonctionne.

Captures d'écran et captures vidéo d'écran

Nous devrions 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 devraient ne pas hésiter à les utiliser ou les supprimer selon le besoin.

Priorité sur la version pour ordinateur

  1. Windows - avec environ 90% de nos utilisateurs sous Windows, il n'y a pas à réfléchir. À partir de maintenant, nous devrions faire des captures d'écran de Windows 7. Quand nous ajouterons la prise en charge de Windows XP, nous pourrons ajouter des captures d'écran dédiées.
  2. Mac - la version actuelle est la 10.8 (Mountain Lion).
  3. Linux - utilisez Ubuntu pour les captures d'écran.

Mobile

  1. Android - 4.0 Ice Cream Sandwich.

Ajouter ou supprimer des articles en anglais

Proposer de nouveaux articles en anglais

Notre base de connaissances est la réponse la plus efficace aux questions que se posent des centaines de millions d'utilisateurs de Firefox. Mais les articles ont tous un coût car chacun doit être écrit, localisé et maintenu. Avec beaucoup de fonctionnalités et de problèmes déjà documentés, notre temps est mieux dépensé à améliorer les articles existants. Avant que vous ne vous jetiez comme un fou dans la création d'articles, réfléchissez aux choses suivantes :

Avons-nous réellement besoin de cet article ?
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. Ceci peut être un aspect inhérent de la fonctionnalité, le résultat de liens externes issus des produits, le résultat d'une campagne mercatique ou une combinaison des trois.
  • 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. Pogo.com et d'autres pages Java ne fonctionnent pas)

Archiver les articles

Nous archiverons périodiquement des articles de la base de connaissances pour se concentrer sur les sujets les plus pressants pour les utilisateurs. Puisque nous sortons une nouvelle version de produits Mozilla toutes les six semaines, les problèmes et sujets sur lesquels les utilisateurs auront besoin de documentation changeront à un rythme plus rapide. Il y aura beaucoup d'articles, comme Comment utiliser les marque-pages pour enregistrer et organiser vos sites web favoris ou Comment définir la page d’accueil, qui resteront pendant longtemps, mais il y en aura d'autres qui deviendront obsolètes ou plus une préoccupation de la part des utilisateurs. Idéalement, nous devrions avoir aux alentours de deux cents articles. Cela nous permettra de documenter des choses avec assez de détails tout en étant suffisamment facile à maintenir et localiser.

Comment cela fonctionne :
Les contributeurs avec des droits de vérificateur 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 des localisations, 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 que l'article n'a pas reçu de nombreuses visites. Si nous nous sommes trompés, un simple clic d'une case permet de faire réapparaître l'article sur les tableaux de bord et dans les résultats de recherche standard.

Éléments à considérer avant d'archiver un article :

  • Peu de vues - Généralement, les articles avec environ moins de mille cinq cent 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 un enjeu sérieux.
  • Changements aux 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

Cet article est déjà tellement long que les directives pour la vérification des articles en anglais sont dans un article dédié.

Cet article vous a-t-il été utile ? Veuillez patienter…

Ces formidables personnes ont aidé à écrire cet article : scoobidiver. Vous pouvez également aider - découvrez comment.