Dokiel

Ce modèle documentaire permet de structurer un guide en chapitres arborescents et s'appuie sur plusieurs items métiers spécifiques :

• les procédures pour la description étape par étape d'actions qu'un utilisateur doit mener dans le logiciel, illustrées ou non de copies d'écran et vidéos d'écran ;

• les concepts pour poser et décrire le vocabulaire technique et métier utilisé dans le logiciel ;

• les écrans pour décrire de manière détaillée chaque zone de la copie d'écran pointée (description de l'interface du logiciel).

Dokiel Guide propose des fonctions spécifiques nécessaires à la documentation logicielle :

• balises dans le texte facilitant l'écriture : onglet textuel, bouton textuel, case à cocher, bouton radio, chemin de menu, chemin d'un fichier, label, icône ou partie d'écran ;

• gestion différenciée des images d'illustration et des copies d'écran du logiciel ;

• vidéos d'écrans simulées grâce aux enchaînements de copies d'écran ;

• création des index (glossaire, copies d'écrans...).

DokielGuide est issu d'un partenariat de recherche entre plusieurs acteurs sur la documentation et formation logicielle. Aujourd'hui, Kelis assure la maintenance de ce modèle documentaire.

L'animateur de la communauté Dokiel Guide est Julie Wojcicki, Kelis.

Pour toute question ou remarque, n'hésitez pas à utiliser le forum.

DokielGuide repose sur la librairie Dokiel.

Pour être tenu au courant des dernières évolutions de Dokiel ou participer aux discussions, nous vous invitons à vous joindre à la mailing-list du projet.

1. Envoyez simplement un mail vide à l'adresse suivante : dokiel-subscribe@scenari-platform.org

2. Vous recevrez une réponse automatique. Répondez à ce message pour activer votre inscription.

3. Vous êtes inscrit à la mailing-list de Dokiel ! Vous recevrez dans votre messagerie les messages de la mailing-list ainsi que les messages postés sur le forum de Dokiel.

Pour écrire à la mailing-list il suffit d'envoyer un mail à l'adresse suivante : dokiel@scenari-platform.org.