Rédiger une documentation utilisateur

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

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

  Les explications doivent être claires, simples, concises.

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

  • Elle peut comporter :

    • des visuels ou aides graphiques tels que des illustrations (voir la documentation Screenshots), des animations ou vidéos de démonstration (voir la documentation Screencast en cours de rédaction) ;

    • des résumés, un glossaire, des recommandations, des trucs et astuces.

  • Les objectifs et les différentes parties doivent être aisément identifiables.

• Elle permet une liberté de consultation.

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

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

• Elle respecte les chartes graphique et 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 de préférence :

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

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

• « évaluée », c'est à dire les utilisateurs ont la possibilité de contacter l'auteur pour une amélioration à apporter à la ressource ;

• « accessible » .

Elle se fait dans le respect du droit d'auteur et du droit de l'image.

Elle s'adresse à un public cible explicitement cité.

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,

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

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éant)

• une explicitation des conventions d'écriture si besoin : modalités de consultation de la documentation, abréviations courantes, mises en forme spécifiques ;

• des notes de version.