Guide de l’utilisateur (gabarit)

Réf. Norme IEEE 1063-1987. Standard for User Documentation.
(en particulier voir la section 5)

1. Page titre
Nom de ce document, version, date, logiciel correspondant, émetteur
2. Restrictions
A propos de reproduction des logiciels ou des documents
3. Garanties et obligations contractuelles du fournisseur
4. Table des matières du document
5. Liste des illustrations
6. Introduction
6.1 Audience.
		Niveau d’expertise, de formation
6.2 Applicabilité du manuel
		Version, matériel, logiciel 
6.3 Objectifs du logiciel, applications typiques
6.4 Utilisation de ce document
		Contenu de chaque section, son intention, relation entre les sections
6.5 Documents connexes
6.6 Conventions
		Symboles, style, syntaxe des commandes
6.7 Procédure pour signaler et rapporter les erreurs

7. Le corps du document 
Deux modes de présentation possibles
	- mode pédagogique
	- mode référence

Dans les deux modes, organiser le contenu de manière consistante en fonction de l’utilisation attendue, avec exemples appropriés. 

Ici, le mode pédagogique est présenté. Pour le mode référence, voir section 5.7.2 de la norme IEEE 1063.

Regrouper les tâches (fonctions) logiquement en scénarios d’utilisation, c’est à dire en séquences d’utilisation typiques. 

Pour chaque tâche indiquer:
7.1 Portée de la tâche
7.2 Matériel nécessaire pour compléter la tâche
	Manuels, mots de passe, matériel informatique, logiciels, interfaces, protocoles.
7.3 Préparations
	Activités d’ordre technique et administratif à faire avant de commencer la tâche.
	Obtenir mot de passe, autorisations, espace disque.
7.4 Avertissements
7.5 Méthode
	Décrire chaque tâche:
	- ce que l’utilisateur doit faire
	- quelle fonction sera invoquée
	- comment reconnaître la terminaison normale
	- erreurs possibles et comment les éviter
	- résultats attendus
	Montrer les images des écrans graphiques (screen prints) appropriés 

7.6 Information connexe
	Toute autre information utile à-propos de
	- regroupements, ensembles de tâches
	- tâches connexes, similaires
	- notes, limitations, et contraintes

8. Messages d’erreur, problèmes connus
Conditions d’erreur communes, comment les détecter
Pour chaque message d’erreur, indiquer la cause, procédures de rétablissement
9. Annexes
Détails selon les besoins, e.g. codes, formats, …
10. Bibliographie
Publications et documents mentionnés dans le texte
11. Glossaire
Termes, acronymes, abréviations peu familières.