Rédiger une documentation utilisateur

Une documentation construite avec Dokiel est structurée à partir de fichiers autonomes appelés items.

Un item de publication (guideWeb.pub et/ou guidePapier.pub) va appeler un item Guide utilisateur qui est composé d'items sections (chapitres).

Chaque section peut comporter des sections, des parties et items fondamentaux tels que les procédures ou les écrans.

Chaque élément est un item dans lequel le rédacteur peut créer du contenu textuel à l'aide de balises de mise en forme du texte et de ressources multimédia (images, enchaînements d'images, screencast, figures, tableaux).

Le guide utilisateur est l'item qui permet de composer la documentation, d'assembler les éléments constitutifs.

Dokiel guide le rédacteur dans l'emplacement de chaque type d'item ; le rédacteur choisit cependant sa propre organisation.

Rédiger une documentation avec Dokiel c'est donc réfléchir à la structuration de son document et établir la correspondance entre ses contenus et les items de Dokiel.

Les éléments suivants seront générés automatiquement par Dokiel :

• les mises en forme de chaque item ;

• la page de couverture pour le guide papier ;

• le sommaire, pour le guide papier, ou l'arborescence de navigation, pour le guide web ;

• le glossaire (il est construit à partir de l'ensemble des items Définitions que l'auteur insérera dans son document).