B02 – Rédiger une documentation d'exploitation

1. Procédure ou documentation d'exploitation ?

	Procédure	Documentation d'exploitation
Question	Comment faire une opération ?	Comment faire vivre le service ?
Taille	Une page	Deux à quatre pages
Lecteur	Celui qui exécute	L'administrateur qui reprend le service
Exemple	Ajouter un utilisateur	Tout ce qu'il faut savoir sur le service de fichiers

2. Le plan type

Partie	Contenu
1. Présentation	À quoi sert le service, pour qui, depuis quand
2. Architecture	Schéma, adresses, noms, dépendances
3. Paramètres	Valeurs de configuration importantes et leur raison
4. Exploitation courante	Démarrer, arrêter, sauvegarder, superviser
5. Dépannage	Table symptôme, cause, action
6. Contacts et escalade	Qui prévenir, dans quel ordre
7. Historique	Date, modification, auteur

Exemple d'architecture (cas fictif)

3. La table symptôme, cause, action

Symptôme	Cause probable	Action
Un poste n'imprime pas, les autres oui	Imprimante non installée sur ce poste	Ajouter l'imprimante depuis le serveur
Personne n'imprime	Service d'impression arrêté	Redémarrer le service, vérifier le journal
Impression très lente	File d'attente bloquée par un document volumineux	Supprimer le document, vider la file

Note

Une bonne table commence par ce que l'utilisateur voit, pas par la cause technique.

4. Exercice : corriger une documentation défaillante

Extrait fictif : « Le serveur est sur le réseau interne. Pour l'imprimante, c'est bon. S'il y a un problème, redémarrer. Voir avec Paul. »

Questions

Liste cinq défauts.
Réécris l'extrait.

Voir la réponse attendue

Défauts : aucune adresse ni nom ; « c'est bon » ne dit rien de vérifiable ; « redémarrer » quoi, comment ? ; « Paul » est une personne, pas un rôle, et sans moyen de contact ; pas de date ni de version.

Réécriture : « Le serveur d'impression (192.168.70.10) est sur le réseau interne. Les imprimantes ont les adresses 192.168.70.21 et 192.168.70.22. En cas d'absence totale d'impression : redémarrer le service d'impression du serveur, puis vérifier l'impression d'une page de test. Si le problème continue, contacter le responsable d'exploitation (voir section Contacts). Version 1, date de rédaction indiquée en en-tête. »

5. Le test du collègue

Donne ta documentation à un camarade qui ne connaît pas le service et pose-lui trois tâches :

Retrouver l'adresse du serveur.
Dire quoi faire si personne ne peut imprimer.
Dire qui prévenir.

S'il bloque, la documentation n'est pas finie. Note ce qui l'a bloqué.

6. Historique des modifications

Version	Date	Modification	Auteur
1	date	Création	rôle
2	date	Ajout de l'imprimante 2	rôle

Grille d'évaluation (20 points)

Critère	Points	Auto-évaluation
Plan complet avec schéma	5
Table symptôme, cause, action	5
Exercice : défauts repérés et texte réécrit	4
Test du collègue réalisé et exploité	4
Historique et versions	2
Total	20