Rédiger une documentation utilisateur

Une documentation est adaptée aux publics auxquels elle se destine.

• Les explications doivent être claires, simples, concises.

  Elle doit pouvoir être lue et comprise en pleine autonomie par un utilisateur cible.

  Elle doit être présentée de manière agréable et lisible.

  • Elle peut comporter des visuels , des aides graphiques, des illustrations, des animations ou vidéos de démonstration, des résumés, un glossaire, des recommandations, des trucs et astuces.

  • Les objectifs et les différentes parties doivent être aisément identifiées par le lecteur.

• Elle permet une liberté de consultation.

  Le lecteur final doit pouvoir naviguer selon les besoins et trouver des réponses aux questions qu'il se pose.

  Elle n'enferme pas, si possible dans un parcours de lecture obligatoire, sauf si la lecture doit être progressive.

• Elle respecte la charte et la charte orthotypographique de l'université.

  Ces chartes sont disponibles dans l'E.N.T., onglet Vie de l'université - Fonctionnement, services, projets - Services rattachés à la présidence et à la DGS - Service de la communication - Chartes.

Elle est si possible :

• conçue et rédigée par une équipe ;

• « expérimentée », c'est à dire de préférence testée avant diffusion.

Elle présente :

• un titre,

• un numéro de version,

• une date de rédaction et, le cas échéant, une date de mise à jour (« mois/année » - « MAJ : mois/année »).

Elle mentionne :

• les auteurs et contributeurs,

• une structure référente,

• des informations relatives au droit d'auteur et de reproduction (consulter le site des creative commons http://creativecommons.fr/licences/)

• des informations relatives aux conditions de diffusion du document (doit-il rester à usage interne ?)

En introduction générale :

• la description de la finalité de la documentation utilisateur : pour qui est-elle rédigée, que contient-elle ? comment doit-on l'utiliser ? que doit apprendre l'utilisateur à la lecture du document ?

• des prérequis (le cas échéants)

• une explicitation des conventions (modalités de consultation de la documentation, abréviations courantes, mises en forme spécifiques, le cas échéant) ;

• des notes de version.