Anatomie d’un article de la base de connaissances

Informations de la révision
  • Identifiant de la révision : 62002
  • Date de création :
  • Créateur : dattaz
  • Commentaire : localisation de la page
  • Vérifiée : Non
  • Prêt pour la localisation : Non
Source de la révision
Contenu de la révision

Ceci est une introduction qui vous donne le contexte de l'article et vous donne un aperçu du contenu. En fessant cela vous pouvez rapidement déterminer si c'est le bon article pour vous.

Dans le cas où vous souhaitez apprendre comment écrire des articles d'aide pour le support Mozilla. Cet article va vous montrer les techniques les plus courante et le balisage wiki que nous utilisons. Vous pouvez aussi suivre cet article c'est guide de lasource wiki que nous utilisons pour écrire.

Généralement, il y a deux types d'article avec deux types d'introduction :

  • introduction d'article tutoriel ou Comment-Faire (How-to) : Un bref sommaire des fonctionnalités ou tâche et les choses pouvant être appris(example).
  • Introducation d'article de résolutions de problème: Un bref sommaire des symptôme et la solution(example).

Comment structurer un article

L'idée générale ici est d'essayer de construire des compétences des plus simples au plus complexe qui va essayer de garder l'information que la majorité des personnes veulent tout en haut. Pour cet exemple, dans cet article Tab Groups nous avons commencé par pourquoi utiliser cette fonctionnalité, puis comment faire un groupe et à la fin les tâches les plus compliquer comme chercher et organiser.

Rédigé une section descriptions que les lecteurs peuvent survoler

En nommant la section après une tâche ou une solution cela autorise les personnes à chercher rapidement dans l'article ou utiliser le sommaire pour voir une partie de l'article. Dans certains cas cela va envoyer les utilisateurs vers une information et ils ne vont jamais lire le reste de l'article.

Crée des instructions étape par étape

Il n'y a rien de plus frustrant de finalement trouver l'information dont vous avez besoin et vous n'arrivez pas à suivre les instructions, car l'auteur connais quelque chose que vous ne connaissez pas. Ceci est la raison de pourquoi faire des instructions par étapes complètes et numéroter. Si vous avez à cliquer sur "OK" à un moment il faut réaliser cette étape.

Vous pouvez voir un exemple d'article Comment définir la page d’accueil:

  1. Ouvre le site web que vous souhaitez avoir en page d'accueil.
  2. Cliquez sur l'icone à gauche de l'adresse de la page, déplacer la sur le bouton home et c'est bon.
  3. Cliquez sur Yes pour paramètres comme votre page accueille

Crée des instructions pour différents systèmes d'exploitation ou versions de Firefox

Souvent les instructions de Firefox sont différentes selon les systèmes d'exploitation. Nous avez un balisage spécial qui permet d'afficher les instructions pour windows aux utilisateurs de windows et les instructions Mac pour les utilisateurs de Mac. Si vous changez de système d'exploitation au haut de l'article le reste de l'article changera.

Astuce: Regarder la source du wiki pour voir comme cela est fait (merci de ne pas changer l'article).

  1. Dans le haut de la fenêtre Windows, cliquez sur le bouton Firefox (Outils menu dans Windows XP) puis cliquez sur Options.
  2. Séléctionné le panneau General .
  3. Dans la boite qui s'ouvre, cliquez sur Remttre à zero.
    Home page Win3
  4. Cliquez sur OK pour fermer la fenêtre Options.

  1. Sur la barre de menu, cliquez sur le menu Firefox et sélectionnez Préferences...
  2. Sélectionner le panneau General .
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zero.
    Home page Mac3
  4. Fermer la fenêtre Préferences.

  1. Dans le haut de la fenêtre Windows, cliquez sur le menu Edit puis sélectionner Preferences.
  2. Sélectionnez le panneau Generale.
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zero.
    Home page Lin3
  4. Cliquez sur Fermer pour fermer la fenêtre Préférences.

Utilisez un templates (modèle) pour vos instructions étapes par étapes

Il y a de nombreuse étapes similaires dans les articles de Firefox. Pour cela nous avons créé des "templates" (vous n'avez donc pas besoin d'écrire et traduire) encore et encore. Habituellement les templates ont des instructions pour tous les systèmes d'exploitation où nous avons écrit des étapes précédemment. Vous pouvez voir les étapes similaires en dessous, mais écrivez avec des templates.

Astuce: Assurez-vous de regarder le balisage wiki pour voir comment cela est fait (merci de ne rien modifier).
  1. Dans la barre des menus en haut de l’écran, cliquez sur Firefox et sélectionnez Paramètres (sélectionnez Préférences sur les anciennes versions de macOS).Cliquez sur le bouton de menu Fx89menuButton et sélectionnez Paramètres
  2. Sélectionnez le panneau Generale.
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zéro.
    Home page Win3Home page Mac3Home page Lin3
  4. Fermez la page des paramètres. Toutes les modifications que vous avez apportées sont automatiquement enregistrées.

Note: Ceci est une liste de nos templates et vous pouvez en apprendre plus en utilisant {for} le balisage dans cet article.