De la création à la publication

Comment est élaborée une documentation ? Voici ce que nous allons décrire dans le détail.

Création

Le format

Qui, pourquoi, ou et quand

Vous êtes les mieux placés pour répondre à ces questions !

Comment - les outils

Le processus de création comprend plusieurs étapes.

  • Le créateur établit un premier jet avec l’outil qui lui convient : simple éditeur de texte, éditeur xml/html, OpenOffice, ce wiki. Un convertisseur OpenOffice > DokuWiki existe. Toutefois, notez que Le présent wiki est principalemet destiné à une création collaborative de documentations pour le projet Nasgaïa.
  • La documentation est peaufinée par tou(te)s sur le wiki (contenu et forme) avant d’être validée.

Validation

La validation est effectuée par l’équipe ngadoc et les membres du projet. Une fois validée la documentation est transformée en fichier xml à l’aide du script wiki2ngadoc puis en fichiers html destinés à la publication.

La conversion en html est effectuée à l’aide de la commande xsltproc et du fichier xslt/single-page.xsl :

$ xsltproc xslt/single-page.xsl votre_document.xml > votre_document.html

Le document html créé utilise les images situés dans le dossier images/ et la feuille de style css/ngadoc.css.

Publication

La documentation (fichiers html / xhtml + css) est alors officiellement mise à disposition dess utilisateurs sur le site nasgaia.org. La documentation complète sera également disponible sous forme de paquet régulièrement mis à jour.

Classement

Arborescence :

/nga1.0
/nga1.0/theme1/
[...]
/nga1.0/themen/

/nga2.0
/nga2.0/theme1/
[...]
/nga2.0/themen/

/divers
/divers/theme1/
[...]
/divers/themen/

Il faut bien définir les noms des dossiers. Un script php créé l’index et génère la documentation avec un bandeau de navigation. Un moteur de recherche sera créé.

Un paquet “documentation” sera proposé, avec un moteur de recherche offline simple.

 
ngadoc_processus.txt · Dernière modification: 26/11/2005 19:56 par fraazz
 
Recent changes RSS feed Creative Commons License Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki