Des outils, des contacts, un accompagnement

La rédaction de documentation utilisateur repose sur un processus de création publication porté par la Direction du numérique.

Elle suppose en particulier l'utilisation d'une chaîne éditoriale qui propose un format de rédaction pré-structurée : Dokiel (basé sur Scenari[1]).

ConceptUne chaîne éditoriale ...

... est un procédé technologique qui permet :

  • de rédiger de façon assistée un contenu à partir d'un environnement de travail unique pour toute une communauté ou pour des groupes de rédacteurs ; le logiciel de part son fonctionnement aide dans la structuration et dans la mise en forme du document final ;

  • de décliner de façon automatique la publication de sa documentation sur différents supports : en l'occurrence pour Dokiel, un support web et/ou un support PDF imprimable.

ConceptDokiel (en référence à Documentation et à logiciel) ...

... propose donc des items de rédaction adaptés aux besoins spécifiques de la documentation utilisateur logicielle.

Il permet de créer des documentations intégrant des captures d'écran statiques ou animées (animations par enchaînement d'images ou insertion de tutoriels animés).

Au-delà de la stricte documentation logicielle, Dokiel est plus largement utilisé à l'université pour rédiger des documents techniques procéduraux ou plus globalement des documentations utilisateur.

Exemple

On trouvera ainsi par exemple des mises en forme spécifiques pour présentation d'écrans commentés (exemple) ou de procédures à suivre (exemple).

Les auteurs et autrices se connectent à ScenariServer (connexion distante) pour accéder à leur atelier de rédaction.

Ils et elles pourront être amenées à insérer des items pour lesquels il sera nécessaire de savoir utiliser des outils de capture écran. Ces compétences ne sont pas indispensables à la rédaction de documentations à l'aide de Dokiel. Une documentation utilisateur est proposée ci-après pour l'utilisation de logiciels installés (ou installables) sur les postes informatiques gérés par la Direction du numérique.