Anatomie de la Base de Connaissance

Ceci est une introduction qui vous donne le contexte de l'article et vous donne un aperçu du contenu. En faisant 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 courantes et le balisage wiki que nous utilisons. Vous pouvez aussi suivre cet article c'est le guide de lasource wiki que nous utilisons pour écrire.

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

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

Comment structurer un article

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

Rédiger une section description 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éer des instructions étape par étape

Il n'y a rien de plus frustrant que de finalement trouver l'information dont vous avez besoin sans arriver à suivre les instructions, car l'auteur connaît quelque chose que vous ne connaissez pas. Ceci est la raison pour laquelle il faut faire des instructions par étapes complètes et numérotées. Même s'il y a seulement à cliquer sur "OK" à un moment il faut considérer que c'est une é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'icône à gauche de l'adresse de la page, déplacez-la sur le bouton d'accueil et c'est bon.
  3. Cliquez sur Oui pour la paramètrer comme votre page d'accueil

Créer 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 : Regardez 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éctionnez le panneau Général .
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zéro.
    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 Général .
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zéro.
    Home page Mac3
  4. Fermer la fenêtre Préferences.

  1. Dans le haut de la fenêtre Windows, cliquez sur le menu Édition puis sélectionnez Préférences.
  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 nombreuses é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 pour lesquels 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. En haut de la fenêtre de Firefox, cliquez sur le bouton Firefox, puis sélectionnez OptionsEn haut de la fenêtre de Firefox, cliquez sur le menu Outils, puis sélectionnez OptionsSur la barre de menus, cliquez sur le menu Firefox, puis sélectionnez Préférences…En haut de la fenêtre de Firefox, cliquez sur le menu Édition, puis sélectionnez Préférences

    Cliquez sur le bouton menu New Fx Menu et sélectionnez OptionsPréférences

  2. Sélectionnez le panneau Général.
  3. Dans la boite qui s'ouvre, cliquez sur Remettre à zéro.
    Home page Win3 Home page Mac3 Home page Lin3
  4. Cliquez sur OK pour fermer la fenêtre « Options »Cliquez sur Fermer pour fermer la fenêtre « Préférences »Fermez la fenêtre « Préférences »

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

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

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