Doc-ultime © Tous droits réservés. Politique de confidentialité
Avant de commencer
Il est souvent impératif de :
- bien comprendre le produit ou le sujet à documenter (pour un manuel utilisateur, se faire expliquer le logiciel de façon détaillée et le manipuler soi-même)
- se documenter sur le produit ou le sujet (rassembler et consulter la documentation technique et marketing existante)
- comprendre les attentes des personnes qui liront le document (pour un manuel utilisateur, prévoir que le document pourra être lu par des utilisateurs ayant différents niveaux de connaissance des processus métier de l’entreprise)
Au début de la rédaction
- faire le plan d’ensemble du document. Pour les manuels utilisateur, ce plan découle de l’approche choisie : par fonctions du logiciel (découpe fonctionnelle) ou par processus (approche transversale)
- définir les niveaux de présentation nécessaires, selon la complexité des informations et le niveau des lecteurs du document :
- texte d’introduction
- texte explicatif
- captures d’écran
- schémas et graphiques
- exemples
- rappels dans des encadrés distincts
- résumés partiels dans des encadrés distincts
- encadrés distincts avec des informations de référence (par exemple pour expliquer un concept, un acronyme, un autre processus)
- résumés complets en fin de section ou chapitre
- table des matières
- index
- glossaire
- établir une première charte graphique (définir des styles pour tous les niveaux de présentation et les conventions typographiques)
- définir le type de numérotation des chapitres et sections
Pour la rédaction elle-même
- décrire les conventions typographiques
- écrire une présentation du contenu du document (abstract)
- pour chaque partie et en particulier pour les premiers chapitres, appliquer un cycle itératif « conception - rédaction - validation - modifications » :
- conception : détailler et valider le plan et les éléments du contenu de la partie concernée
- rédaction : rédiger le contenu de la partie concernée
- validation : faire valider par les équipes concernées
- modifications : procéder aux améliorations et modifications demandées et les faire valider
- utiliser un style sobre et simple, avec des phrases courtes
Après la rédaction
- passer le correcteur orthographique ET grammatical sur l’ensemble du document
- faire une impression finale de contrôle
- relire entièrement le document