Comparer les révisions

Guide général pour écrire, modifier et localiser les documents d'assistance

Merci pour votre aide sur nos articles d'assistance. Pour environ quatre millions de personnes par semaine, ces articles sont le visage de Mozilla quand ils ont un problème ou une question sur Firefox. Le travail que vous faites ici a un impact énorme sur des gens du monde entier. En tant que projet open-source sans but lucratif, nous comptons sur les bénévoles pour écrire la majorité des articles. Vous n'avez pas besoin de droits spéciaux pour travailler sur ces derniers - c'est un Wiki que n'importe qui peut modifier. Cette article est un guide général pour écrire et modifier les documents d'assistance. Si vous avez des questions sur n'importe lequel de cela, vous pouvez juste [mailto:&#109;&#118;&#101;&#114;&#100;&#105;&#64;&#109;&#111;&#122;&#105;&#108;&#108;&#97;&#46;&#99;&#111;&#109; m'envoyer un courriel], à Michael, votre ami, le responsable du contenu de l'assistance. __TOC__ <section> = Choses à considérer avant de créer un nouvel article = Avant que vous vous précipitiez comme un fou dans la création de nouveaux articles, revoyons des choses que vous devriez d'abord considérer. Ces règles ne sont pas définies dans le marbre. Si vous avez des questions, vous devriez les poser dans le [https://support.mozilla.com/en-US/forums/knowledge-base-articles forum anglophone des articles]. *'''Quels sujets couvrons-nous dans la base de connaissances ?''' **L'utilisation des fonctionnalités de Firefox comme les onglets, les marque-pages et la synchronisation. **La correction des problèmes comme les plantages ou les problèmes de chargement de sites Web. *'''Quels sujets ne couvrons-nous pas dans la base de connaissances ?''' **Les astuces et piratages pour modifier Firefox. **L'utilisation ou la recommandation de modules complémentaires et plugins particuliers. {note}Les articles de résolution des problèmes sont souvent une exception à ces règles. Si un problème courant ne peut être réglé qu'avec un ''piratage'' ou en installant un module complémentaire particulier, nous documenterons cela.{/note} *'''Avons-nous vraiment besoin de cet article ?''' – Il y a plein de sortes de choses que nous pouvons écrire dans la base de connaissances, mais nous voulons faire la part des choses entre la quantité de travail nécessaire à un article (l'écrire, le maintenir, le localiser) et le nombre de personnes qu'il pourrait potentiellement aider. Nos 20 articles les plus lus comptent pour environ 50% de notre trafic. Souvent, il vaut mieux dépenser son énergie à améliorer un de ces articles. Peut-être que ce que vous pensez documenter conviendrait mieux en ajout à un article existant. </section> ---- <section> = Créer un nouvel article = Si vous pensez qu'il y a un article que nous devons ajouter à la base de connaissances, voici comment faire. #Rendez-vous sur le [https://support.mozilla.com/en-US/forums/knowledge-base-articles forum anglophone des articles] et proposez de créer l'article. #*Créer un nouveau sujet de discussion, intitulez-le « <nowiki>[Proposed]</nowiki> Nom de l'article » et expliquez ce que l'article couvrira. #Attendez les commentaires à votre proposition. C'est facultatif, mais si vous avez l'intention de rédiger l'article vous-même, vous devriez entendre ce que les autres ont à dire avant que vous le fassiez. #[https://support-stage.mozilla.com/kb/new Créez] et rédigez l'article. #Quand vous avez terminé la rédaction de l'article, ajoutez un lien vers lui dans le sujet de discussion sur l'article et changez le titre du sujet de discussion en « <nowiki>[Needs Review]</nowiki> Nom de l'article ». #*Faire ceci aide les gens à savoir que l'article est en attente de vérification. #*L'article ne sera rendu publique qu'après une vérification et une approbation. </section> ---- <section> = Améliorer les articles existants = La chose la plus courante que nous fassions dans le monde de la maintenance de la base de connaissances est d'essayer d'améliorer les articles que nous avons déjà. Avec presque 300 d'entre eux, il y a toujours quelque chose qui peut être améliorée. Voici les trois principaux moyens d'améliorer un article : *'''Rendre les articles plus facile à comprendre''' **Trouvez un meilleur moyen d'expliquer quelque chose qui est trop complexe ou pas vraiment claire. **Ajoutez des captures d'écran pour aider les gens à comprendre à quoi l'article fait référence. La plupart des gens ne connaissent probablement pas la différence entre la barre d'adresse, la barre de recherche ou tout autre barre. **Ajoutez des captures vidéo de l'écran. C'est la meilleure des choses que de prendre la souris de la main de quelqu'un et de faire le boulot à sa place. *'''Garder les articles à jour''' – Les mises à jour importantes de Firefox apportent toujours des nouvelles fonctionnalités et des changements à celles qui existent déjà. C'est toujours mieux quand nos instructions correspondent à la manière dont les choses fonctionnent actuellement dans le produit. *'''Relire''' – Certains d'entre vous ont des capacités spéciales pour mettre en évidence les erreurs que le correcteur orthographique a loupé (combien en avez-vous notées dans cet article jusqu'à maintenant ?). Nous avons besoin de votre aide. **Corrigez les fautes d'orthographe, de grammaire et de ponctuation. **Arrangez les problèmes de style et de formatage. Consultez la section style de SUMO pour nos directives. </section> ---- <section> =Écrire des articles= Il y a beaucoup de choses en concurrence à soupeser quand vous écrivez ou modifier un article. Vous voulez être tout à la fois complet et concis ; factuel et intéressant. Ce n'est pas la chose la plus facile à faire. Voici des directives pour aider à rendre ce jugement un peu plus facile. C'est également un Wiki et nous pouvons toujours réviser quelque chose si nous nous sommes trompés. ==Techniques pour rendre votre écriture captivante== L'aide de Firefox est un répertoire d'informations techniques sur l'utilisation du navigateur Web Firefox. La documentation liste les fonctions des différentes fonctionnalités de Firefox, les procédures de diagnostic des problèmes et les instructions pour la résolution des problèmes courants. On peut accéder à la documentation en utilisant la fonction de recherche sur chaque page. Le paragraphe précédent semble un peu ennuyeux. L'utilisation de l'humour et des émotions (SURPRISE !) sont des techniques que nous pouvons utiliser pour captiver l'attention des gens. Ces techniques, que j'ai listées ci-dessous, ont toutes pour but de rendre votre cerveau attentif en recréant ce que cette interaction pourrait être si elle arrivait en personne. Quand nous faisons cela, les informations sont plus faciles à comprendre et à se souvenir. *'''Style d'écriture conversationnel''' – Utilisez un style informel et actif semblable à la manière dont vous parleriez en personne à quelqu'un. *'''Humour et émotion''' – L'utilisation de l'humour est bien, mais c'est quelque chose de dur ou impossible à localiser. Les émotions comme la surprise et "je ne savais pas cela !" pourraient être plus facile à intégrer. *'''Multiples styles d'apprentissage''' – Comme à l'école, les gens apprennent différemment. Ainsi, tout le monde tire profit de voir le même contenu exprimé de multiples façons. *'''Répétition''' – Quand vous expliquez quelque chose de différentes manières avec différents médias, vous êtes évidemment en train de le répéter, ce qui est un autre bon moyen d'aider les gens à se souvenir de ce qui est important. *'''Images et vidéos''' – L'utilisation des images et vidéos pour expliquer les choses avec du texte n'est pas la seule façon d'être là à aider en personne, c'est un moyen facile d'inclure les multiples styles d'apprentissage et la répétition. *'''Activités''' – Il est bon de donner aux gens quelque chose d'utile à faire, particulièrement dans un tutoriel. C'est une chose de lire des instructions et de comprendre le processus, mais c'est souvent efficace de rappeler aux gens de tester les choses. L'article [[How to set the home page]] est un bon exemple de l'utilisation de ces techniques. ==Public== Nous voulons que l'aide de Firefox soit utilisable par tous les utilisateurs de Firefox. Cela signifie que nous écrivons pour un large public plutôt que pour un public très familier avec les techniques et la terminologie informatique. Supposez que la personne pour qui vous écrivez ne connaît pas la manière de modifier les préférences ou d'ajouter un bouton de barre d'outils sans des instructions pas-à-pas. Nous devrions également supposer qu'ils n'ont changé aucun des paramètres par défaut de Firefox ou du système d'exploitation. ==Noms des articles== En choisissant un titre pour un article, nous voulons essayer de faire correspondre ce que les gens recherchent à la question qu'ils pourrait vous poser en personne. Voici des exemples des sortes de titres que vous pourriez choisir : *Pour un tutoriel ou un article sur comment faire : comment je parvient à ce résultat ? (p.ex., Comment définir la page d'accueil ?) *Pour un article de référence : Qu'est-ce que le (Que sont les) « nom(s) de la fonctionnalité » ? (p.ex, Que sont les onglets épinglés ?) *Pour un article de résolution des problèmes : C'est le problème que je suis en train d'avoir (p.ex, Firefox met plusieurs minutes à démarrer) ==Organisation== L'idée générale ici est d'essayer de construire des compétences du simple au complexe en essayant de garder les informations nécessaires à la plupart des gens au début. Ainsi une solution simple et courante viendrait habituellement avant une solution complexe ou liée à un cas limite. ==Introduction== Avec le titre et la table des matières, l'introduction est ce que les gens utilisent pour déterminer rapidement s'ils sont au bon endroit. *Pour un tutoriel ou un article sur comment faire : Donnez un bref résumé des choses qui peuvent être apprises. *Pour un article de référence : Donnez une brève explication de la fonctionnalité. *Pour un article de résolution des problèmes : Donnez un bref résumé du problème et de ses symptômes. ==Instructions pas-à-pas== La chose principale à garder à l'esprit lors de l'écriture d'instructions pas-à-pas est d'être attentif à l'inclusion de toutes les actions nécessaires pour la réalisation de la tâche. Si, par exemple, vous devez cliquer sur "OK" après la sélection d'une préférence afin d'aller à l'étape suivante, assurez-vous de mettre « cliquez sur OK » dans l'étape. Le choses supplémentaires suivantes sont à considérer : *Il y a toujours plusieurs façons d'arriver à un résultat. Nous devrions toujours choisir la façon la plus conviviale, c'est à dire l'utilisation de l'interface utilisateur graphique et des menus quand c'est possible. *Utilisez des phrases complètes en décrivant la manière d'accéder à l'interface utilisateur. *Incluez les résultats attendus en donnant les instructions (c.-à-d., cliquez sur OK et la fenêtre se ferme.) Voici un exemple extrait de l'article [[How to set the home page]] avec des explications entre parenthèses. === Définir un unique site Web comme page d'accueil === (Le titre - ce que les étapes vont accomplir) ''Si vous aimez que les choses soient simples, voici un moyen de définir votre page d'accueil en trois étapes faciles''<br> (Contexte - montre une vue d'ensemble - pourquoi nous faisons cela) # Rendez-vous sur la page que vous désirez comme page d'accueil. # Cliquez sur l'icône à gauche de la barre de navigation et faites le glisser vers le bouton « Accueil », puis relâchez le clic souris. # Cliquez sur « Oui » pour confirmer. <br>'''Faites un essai :''' Cliquez sur le bouton « Accueil » et votre nouvelle page d'accueil se charge dans l'onglet en cours. Ce n'est pas plus compliqué que cela ! <br> (Activité – donne une mission au lecteur et décrit le résultat attendu) </section> ---- <section> = Style SUMO = En général, nous devrions utiliser un style conversationnel et actif comme si vous parliez en personne avec quelqu'un. Donc vous devriez éviter de dire des choses comme, "si les marque-pages d'un utilisateur sont perdus..." et dire plutôt, "Si vous avez perdu vos marque-pages..." Voici d'autres problèmes courants de style que vous pouvez rencontrer en écrivant des articles d'assistance : '''Toujours utiliser les termes de la manière dont ils apparaissent dans l'interface de Firefox.''' Par exemple : *Plugin n'a pas de trait d'union. *Popup n'a pas de trait d'union. '''Termes informatique généraux :''' *Internet a sa première lettre en majuscule. *Web a sa première lettre en majuscule. *Utiliser courrier électronique ou courriel plutôt qu'e-mail. '''Les liens vers mozilla.com ne devraient pas contenir la langue :''' *Utilisez http://www.mozilla.com/firefox au lieu de http://www.mozilla.com/en-US/firefox '''Mettez en majuscule les éléments suivants :''' *Les noms propres *Le premier mot d'une phrase complète *Les lettres des abréviations et acronymes sauf s'ils sont normalement en minuscules *Le premier mot dans les listes numérotées et à puces *Le nom d'une touche sur le clavier *Le premier mot d'un titre de paragraphe ou d'article '''Titres et sections''' Notre Wiki est affiché en utilisant HTML5 qui utilise l'élément <nowiki><section></nowiki>. Vous pouvez utiliser l'élément <nowiki><section></nowiki> autour d'un contenu lié. Ce que cela signifie pour les titres est que chaque section peut avoir son propre résumé au début avec un titre de niveau h1. '''Nous avons des styles visuels spéciaux pour un nombre d'éléments qui peuvent être réalisés en ajoutant la balise Wiki autour de l'élément (voir [[Kitsune Markup]]).''' *{note}Note{/note} *{warning}Avertissement{/warning} *<code>Code</code> *{filepath Noms de fichier} et {filepath chemin/fichier} *Raccourcis clavier comme {key Ctrl+T} *Menus – {menu Firefox} *{button Boutons} '''Nous avons une balise Wiki spéciale (appelée "showfor") qui vous permet de cibler les informations pour les versions particulières de Firefox ou de systèmes d'exploitation.''' Par exemple, vous affichez un jeu d'instructions aux gens exécutant Windows et un autre aux gens utilisant Mac OS X (voir [[Kitsune Markup]]). </section> = Localiser les articles = ''« Le bon traducteur ne traduit pas mot à mot ni même phrase par phrase ; d’instinct comme de raison, il se réfère à chaque instant au contexte. »'' (Georges Elgozy, ''Le Désordinateur''). Pour illustrer cette citation, le titre de l'article anglais « Superheroes wanted ! » a été traduit en français par « Bénévoles recherchés ! ». En effet, il fait appel à un humour basé sur les bandes dessinées nord-américaines qui peut difficilement être compris par un public francophone. Pour plus d'informations sur la traduction en français de documents techniques, consultez le [https://developer.mozilla.org/Project:fr/Guide_du_r%C3%A9dacteur guide du rédacteur français du Mozilla Developer Center]