Dokiel Guide

Dokiel Guide, une chaîne éditoriale pour la documentation logicielle

La chaîne éditoriale Dokiel Guide : qu'est-ce-que c'est ?

Dokiel Guide permet de créer les documents de type manuel de prise en main, guide utilisateur, documentation de référence... d'un logiciel en web et papier.

Les particularités de Dokiel Guide

La structure du modèle documentaire permet de structurer un guide en chapitres arborescent et s'appuie sur deux types d'items métiers remarquables :

  • les procédures pour la description étape par étape d'actions utilisateur à 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 ;

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

  • balises dans le texte facilitant l'écriture : 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 ;
  • création des index (glossaire, copies d'écrans...).

Quelques images

Acteurs

Dokiel Guide est un résultat issu d'un partenariat de recherche plus large sur la documentation et formation logicielle entre l'UTC, l'AMUE et Kelis qui assure la réalisation technique.

L'animateur est Julie Wojcicki.

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

La librairie Dokiel

Dokiel Guide repose sur la librairie Dokiel (dkCore).

Rejoignez la communauté 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.

Pour plus d'informations...