WikisAdmins:Policy

Un article de WikisAdmins.

Sommaire

Construction d'un tutoriel

Les différentes étapes

Les tutoriels passent par différentes étapes avant leur version finale :

  1. Ébauche : le tutoriel est disponible pour son écriture.
  2. En cours de rédaction : personne ne doit modifier le tutoriels mis à part l'auteur qui à pris en charge le travail. Par contre, des suggestions sont les bienvenue dans la partie "discussion"
  3. À tester : l'auteur considère avoir fini son tutoriel mais pour être sûr de ça fiabilité, il le marque "À tester" afin que quelqu'un vérifie que le tutoriel se déroule sans problème.
  4. En test : un testeur est en train de vérifier le tutoriels
  5. Approuvé : le testeur et l'auteur se sont mis d'accord pour approuver la version finale du tutoriel. Ils décident donc de le marquer "Approuvé"

Ces différents stades ont pour but non seulement d'obtenir un tutoriel final fiable mais aussi donner une idée du degrés de sa fiabilité.

Une cartouche dans l' en-tête

Chaque tutoriel doit comporter en entête, une cartouche regroupant :

  • une définition courte du sujet
  • un liens vers le site wikipédia concernant le sujet
  • le degrés de fiabilité (progression des étapes)
  • le nom ou le pseudo de l' (ou des) auteurs principal(aux)
  • la date de la première ébauche
  • le système, la distribution ou le matériel (et son firmware) concerné
  • le ou les logiciels nécessaires

Cette cartouche permet d'avoir une idée de l'avancement du tutoriel en un seul coup d'oeil.

Structure modèle d'un tutoriel

Les tutoriels respectent une structure modèle afin que le lecteur puisse se repérer plus rapidement dans chacun d'entre eux. Ils sont donc généralement composé des différentes parties suivantes :

  1. La cartouche
  2. Introduction
  3. Installation
  4. Configuration
  5. Conclusion
  6. Liens et sources

Ceci dit, une certaine souplesse est bien sûr autorisée en fonction des besoins rédactionnels.

Choix des adresses IP

Toujours pour des raisons de facilité et de rapidité de lecture du tutoriel, une convention est respecté en fonction du type de réseau dans le choix de l'adressage IP pour concrétiser les exemples :

  • Plage d'adresses des réseaux locaux de moins de 200 machines : utilisation de la classe C (192.168.1.0/24)
  • Plage d'adresses des réseaux locaux de moins de 60 000 machines : utilisation de la classe B (172.16.0.0/16) uniquement dans des cas bien précis.
  • Plage d'adresses des réseaux inter-routeurs : utilisation de la classe A (10.0.0.0/8)
  • Adresse de la patte de sortie vers l'internet : 192.168.1.1
  • Adresse du serveur DNS primaire : 192.168.1.2
  • Adresse du serveur DNS secondaire : 192.168.1.3
  • Adresse du contrôleur de domaine : 192.168.1.4
  • Adresse du serveur de fichier : 192.168.1.5
  • (d'autres conventions d'adressage IP seront mis en place par la suite)

Un modèle de tutoriel

Pour facilité l'écriture de nouveaux tutoriels, voici un modèle qui permettra aux rédacteurs de gagner du temps lors de la construction de la première ébauche.


Consultez le Guide de l’utilisateur pour plus d’informations sur l’utilisation de Médiawiki.