Modèle Dokiel (Documentation Logicelle)

• Date de création : 2006
• Partenaires :
  • Kelis
  • AMUE

Ce projet repose sur le Système de Gestion de Chaînes Editoriales SCENARI http://scenari-platform.org

Présentation

Le projet Dokiel (SoftDoc à l'origine) est parti du constat que pour un éditeur ou un utilisateur de progiciels complexes, créer et maintenir les supports nécessaires à l'apprentissage d'un logiciel et du métier est une gageure : diaporamas de formation, guide utilisateur, livret de corrections d'exercices, support stagiaire, diaporama de présentation, guide des évolutions, didacticiel, aide en ligne...

Dokiel regroupe des éléments coeurs de la documentation logicielle, c'est-à-dire l'écriture de procédure, la description d'écrans, de traitements automatiques, l'écriture de concepts et de définitions, ainsi que deux scénarios : le Guide utilisateur et le Programme de formation.

L'idée

• Mutualiser le contenu entre les différents types de documents,
• Créer différents scénarios propres à chaque contexte d'exploitation,
• Publier en différents formats.

En pratique

Cette bibliothèque d'éléments est utilisée pour créer des modèles comme DokielGuide. Dokiel contient les éléments structurants de la chaîne éditoriale, ce qui pose le schémas des modèles dokiel (les .model), ainsi que leurs règles de transformation associées. Les générateurs et styles étant propres à chaque chaîne éditoriale, ils ne sont pas présents dans la bibliothèque.

• Dokiel Guide permet d'écrire une documentation logicielle, des fiches de support etc. en diffusion libre et gratuite.
• SWAD permet d'écrire une documentation de chaîne éditoriale Scenari, avec ses différents supports : présentation d'atelier, présentation d'application et aide embarquée.

Schema technique des relations entre les trois projets :

Votre dérivation de Dokiel

Deux cas possibles : vous avez seulement besoin de la partie Guide de Dokiel ou vous avez aussi besoin de la partie Formation. Schéma technique des ces possibilités :

Attention !
Il n'existe pas de produit basé sur la partie Formation de Dokiel comme il existe l'application DokielGuide pour la partie Guide de Dokiel.

Wiki / bugtracking / suivi subversion avec Trac

Cet espace utilise le programme Trac pour vous permettre de gerer un Wiki, une liste de Tickets (suggestions ou bugs en rapport a votre modèle), et de suivre l'évolution des révisions subversion.

• Référence rapide pour éditer le Wiki
•  Documentation complète (en anglais)
• Mini guide subversion