Dernière mise à jour:
Cette vidéo d’introduction vous donne le contexte de l’article suivant et vous donne un aperçu du contenu. En regardant la vidéo, vous pouvez rapidement déterminer si c’est le bon article pour vous.
Vous souhaitez apprendre comment écrire des articles d’aide pour l’assistance de Mozilla ? Cet article vous montre nos techniques les plus courantes et les balises wiki importantes. Vous pouvez aussi vous servir de cet article et de son code source wiki en tant que guide lorsque vous rédigez un article.
Généralement, il y a deux types d’articles avec deux types d’introductions :
- articles tutoriels ou « Comment faire ? » (How-to) : un bref résumé des fonctionnalités ou tâches et les choses pouvant être apprises (exemple) ;
- articles de résolutions de problème : un bref résumé des symptômes et des solutions possibles (exemple).
Table des matières
Comment structurer un article
L’idée générale ici est d’essayer et de développer des compétences des plus simples aux plus complexes, tout en essayant de garder l’information nécessaire à la majorité des personnes tout en haut. Une solution simple et courante précède généralement une solution complexe ou un cas particulier.
Rédiger des titres de section descriptifs afin que lecteurs et lectrices puissent les scanner rapidement
Le fait de nommer l’en-tête de la section d’après la tâche ou la solution permet au lecteur ou à la lectrice de parcourir rapidement l’article ou de parcourir la table des matières pour apprécier la portée de l’article. Dans certains cas, cela peut déjà fournir suffisamment d’informations à nombre d’utilisateurs et d’utilisatrice qui n’auront même pas besoin de lire le reste de l’article.
Créer des instructions pas à pas
Il n’y a rien de plus frustrant que de finalement trouver les instructions dont vous avez besoin sans arriver à les suivre, car la personne ayant rédigé l’article connaît quelque chose que vous ne connaissez pas. C’est pourquoi nous décomposons nos instructions en étapes complètes et numérotées. Même s’il est nécessaire de cliquer sur « OK » à un moment donné, nous considérons cela comme une étape.
Vous pouvez voir un exemple d’article Comment définir la page d’accueil :
- Ouvrez la page web que vous souhaitez avoir en page d’accueil.
- Glissez-déposez cet onglet sur le bouton d’accueil
de votre barre d’outils.
- Cliquez sur dans l’invite pour faire de cette page votre page d’accueil.
Créer des instructions pour différents systèmes d’exploitation ou versions de Firefox
Les instructions de Firefox sont souvent différentes selon les systèmes d’exploitation. Nous avons un balisage spécial qui affiche les instructions pour Windows aux utilisateurs et utilisatrices de Windows et les instructions pour Mac pour les personnes utilisant Mac. Si vous changez de système d’exploitation dans la boîte sous Personnaliser cet article à droite, les instructions ci-dessous sont modifiées en fonction du système d’exploitation sélectionné. Cet exemple est tiré de l’article Trouver quelle version de Firefox vous utilisez.
Cliquez sur le bouton de menu puis sur et sélectionnez enfin Dans la barre de menu, cliquez sur le menu et sélectionnez . La fenêtre À propos de Firefox apparaît. Le numéro de version est inscrit sous le nom Firefox.
Utilisez un template (modèle) dans vos instructions
Il y a de nombreuses étapes similaires dans les articles de Firefox. Pour cela nous avons créé des templates pour que vous n’ayez ni besoin d’écrire ni de traduire encore et encore. Habituellement, les modèles contiennent des instructions pour tous les systèmes d’exploitation afin de simplifier et d’accélérer grandement la rédaction des étapes.
Cet exemple tiré de l’article Comment définir la page d’accueil comprend un modèle qui donne des instructions pour ouvrir le panneau des paramètres de Firefox.
- Dans la barre des menus en haut de l’écran, cliquez sur et sélectionnez ou selon la version de votre macOS.Cliquez sur le bouton de menu et sélectionnez
- Cliquez sur le panneau
- Cliquez sur le menu à côté de Page d’accueil et nouvelles fenêtres et choisissez la page d’accueil de Firefox (par défaut), les adresses web personnalisées ou une page vide.
Guides pour la base de connaissances
Pour davantage de guides pour la contribution à la base de connaissances, consultez cette page.
