La documentation des produits développés par Jaluna apporte une
dimension essentielle dans l'acceptation de ceux-ci par les
clients. Cette dimension inclut l'organisation générale de la
documentation, son contenu, son accessiblité et sa présentation.
L'utilisation d'un système de production basé sur DocBook nous a
permis, à partir d'une base de sources XML, de produire un ensemble
de documentation cohérent disponible dans deux formats, le premier
(HTML) adapté à l'utilisation au jour le jour des produits, incluant
en particulier un mécanisme de navigation performant, le second (PDF)
permettant d'imprimer des documents de référence.
DocBook, en structurant clairement la documentation, avec
l'introduction de feuilles de style et d'outils de transformation
paramétrables autorise une séparation des
différentes fonctions liées à la production de la
documentation : édition du contenu, présentation,
création de références, organisation globale...
Cet outil nous a permis un travail collaboratif efficace entre la
responsable du système de publication, de la qualité
et de la cohérence globale de la documentation, et les ingénieurs en
charge de la production du contenu.
L'utilisation de ce système de production doit être maintenu pour
les futurs produits de Jaluna, ce qui nécessite, en particulier, la
prise en compte des évolutions apportées par la communauté.