Types de documentation
Une documentation utilisateur, dans le cadre de l'utilisation des outils numériques, doit faciliter l'utilisation d'une solution applicative et permettre à l'utilisateur cible de se familiariser avec les fonctionnalités proposées pour atteindre un objectif donné.
On parlera de mode d'emploi, d'aide en ligne, tutoriel, manuel utilisateur, guide d'utilisation, lorsqu'il s'agit d'aide à la prise en main d'un logiciel ou d'une application avec une déclinaison de type :
guide d'installation,
guide de démarrage rapide,
aide au paramétrage,
fiche fonctionnalités,
aide mémoire,
pas à pas
ensemble de recommandations.
On peut trouver des documents de type manuel utilisateur ou manuel de référence. Ils donnent un aperçu complet des possibilités de l'outil.
Complément
Il existe aussi, comme type de documents utilisateur :
des fichiers d'aide en ligne ; ils sont insérés au sein des applications de façon contextuelle (bulles d'aide) ;
des Foire Aux Questions (FAQ).
Ils ne sont pas abordés ici.
Ce vocabulaire documentation utilisateur peut s'appliquer à toute documentation utilisateur qui permet de se familiariser avec des procédures à respecter, même si l'on entend alors plutôt parler de guide procédural ou fonctionnel.
Le vocabulaire utilisé par l'auteur d'une documentation utilisateur pour désigner son document est en fait révélateur de son intention.
Le type de documentation dépend en effet de son objectif pour le public cible. Sa documentation va répondre aux besoins connus, identifiés ou pressentis des utilisateurs qu'il souhaite accompagner.
Du type de documentation va dépendre l'ossature à imaginer, les outils à utiliser.
Les modes de rédaction, à partir d'un même outil, varient donc d'un objet, d'un contexte à l'autre et selon les choix des auteurs.
On trouve des rédactions modulaires qui permettent au lecteur de choisir son entrée par thème :
Exemple 1 : Un guide utilisateur renvoyant vers trois autres guides utilisateur ;
Exemple 2 : Un document de type Site de référence (plusieurs entrées autour d'un même thème).
On trouve des documentations autour d'un outil pour lesquelles l'auteur choisit de distinguer les aspects techniques (prise en main) des aspects réglementaires.
L'exemple de la documentation pour Agadir :
- Un document pour les modalités d'accès et d'utilisation avec un accès profil utilisateur.
- Il est complété d'un guide des bonnes pratiques selon le cadre légal et les règles en vigueur à l'Unistra.
On trouve des documentations fonctionnelles sans documentation technique, l'outil ne le justifiant pas la rédaction d'une documentation « technique ».
La DUN propose d'utiliser Dokiel pour ce type de document car il permet au rédacteur de se concentrer sur ses intentions plutôt que sur la mise en forme du document. Ainsi Dokiel propose une charte commune à tous les documents de type Documentation utilisateur.