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·e utilisateur·rice 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 ;

    • 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.

  La ou 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 Ernest, onglet « L'Université », « Services centraux », « Direction de la communication » : rubrique « Sommaire », pour « Mettre en forme des supports de communication au langage visuel » et rubrique « Documentation » pour « Charte orthotypographique Unistra ».

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 utilisateur·rices ont la possibilité de contacter l'auteur·rice pour une amélioration à apporter à la ressource ;

• « accessible » .

Elle se fait dans le respect des réglementation en vigueur, en particulier du droit d'auteur et du droit à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 auteur·rices et contributeur·rices,

• 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-on apprendre à 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.