Re: [Dolibarr-dev] Format de documentation

[Brian FRAVAL]

Le 15/09/03 à 17:17, Rodolphe Quiedeville a écrit:
> Salut,

Salut,
 
> On va être amené à écrire de plus en plus de doc pour les
> développeurs, pour l'instant j'ai choisis le format de documentation
> debiandoc qui permet une écriture en sgml de la doc pour la générer
> ensuite en pdf, html, txt ce qui pour moi est indispensable. 
> 
> Mais je suis de moins en moins satisfait par ce format, il est encore
> temps d'en changer sans trop de travail, avez-vous des choses à
> proposer sur ce point.

Rodolphe, est ce que tu peux en dire plus sur les points négatifs
de debiandoc ?

Personnellement, je ne connaissais pas ce format avant de regarder
la documentation de Dolibarr. 
 
> Une contrainte supplémentaire étant de pouvoir splitter la doc en
> plusieurs fichier pour l'écriture par exemple de chaque paragraphe
> dans un fichier.
> 
> Merci pour vos propositions,

Comme le préconise mose, Docbook est vraiment très bien.

- C'est assez simple à apprendre... et je peux mettre le bouquin
  en anglais d'Oreilly sur le web.
- Tu peux générer tous les formats
- Tu peux utiliser soit du XML ou du SGML
- Linux Documentation Project, PHP, etc.. utilise Docbook
        http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/
        http://cvs.php.net/cvs.php/phpdoc?login=2

Sinon j'ai quelques connaissances en Docbook, 
        - J'ai réalisé la documentation du Système d'information de Tiscali.
        - Le projet EducPlus, est basé sur Docbook 
          http://savannah.gnu.org/cgi-bin/viewcvs/educplus/educplus/


-- 
Brian FRAVAL
address@hidden
http://brian.fraval.org/