Méthode de rédaction de la documentation utilisateur
En informatique, c’est souvent le développeur qui est chargé de rédiger la documentation à l’usage des utilisateurs.
C’est une ERREUR fondamentale.
Documentation passive
En effet, par exemple, le programmeur à tendance à indiquer que dans telle zone, il est possible de saisir tel ou tel code, paramètre ou information.
Parfois, il ajoute la compatibilité entre les zones à saisir dans un écran. C’est la DOCUMENTATION PASSIVE.
Il ne faut cependant pas supprimer entièrement ce type de documentation car il est ainsi possible de créer une table des fonctions informatisées par ordre alphabétique, avec l’indication des domaines fonctionnels où elles sont utilisées.
Cette table permet de retrouver rapidement les documentations utilisateurs actives pour les modifier lorsqu’un processus ou un programme est modifié.
Documentation active
La documentation utilisateur doit être rédigée par un utilisateur, un organisateur ou une personne du service qualité. Bref, par une personne qui connaît bien le fonctionnement de l’entreprise ou du service où le programme sera utilisé.
C’est cette personne qui sera à même de positionner le nouveau programme à l’intérieur du processus fonctionnel.
C’est pourquoi, la documentation sera rédigée pour décrire les PROCESSUS.
C’est la DOCUMENTATION ACTIVE
Le sommaire, ou table des matières, de la documentation, comprendra des phrases avec un verbe d’action, en utilisant le vocabulaire fonctionnel, de telle façon que l’utilisateur sache COMMENT faire.
Exemple de table des matières d’une documentation utilisateur
Pour chacune des fonctions du processus, un texte explicatif indiquera à l’utilisateur de qu’il doit faire et comment le faire, que la fonction soit informatisée ou pas.
Dans un magasin :
A) Le client se présente (ou téléphone) pour un besoin de marchandises
A1) Vous savez exactement quel est le produit à remettre ainsi que la quantité
A11) Le client veut enlever la marchandise immédiatement
A12) Le client veut être livré ou passera enlever la marchandise plus tard
A2) Vous ne pouvez pas définir exactement l’article que cherche le client
A21) L’article et la quantité peuvent être précisés au magasin
A22) Le client veut une remise de prix, un devis
A221) Création d’un devis
A222) Copie d’un devis en commande
A23) Le commercial va prendre en charge le client à l’écart de la réception
Philippe Garin, plus de 20 ans de management en entreprise
Pour plus de conseils, contactez-moi : phgarin@gmail.com
Pour en savoir plus :
En complément :
Durée d’archivage des documents
Modes de pilotage en entreprise
Texte dans un site Web : 20 Questions à se poser avant de rédiger
Processus
Méthode ACTE : Les deux définitions
Affinement pas à pas ou effet de loupe
Autres Organisation :
Blog de Philippe Garin 