Re: [Dolibarr-dev] Format de documentation

[Rodolphe Quiedeville]

le Mon, 15 Sep 2003 19:42:35 +0200
mose <address@hidden> a écrit :
> le Mon, Sep 15, 2003 at 05:17:44PM +0200 par Rodolphe Quiedeville :
> > 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.
> > 
> > Une contrainte supplémentaire étant de pouvoir splitter la doc en
> > plusieurs fichier pour l'écriture par exemple de chaque paragraphe
> > dans un fichier.
> 
> - je viens d'essayer 'conglomerate' un editeur docbook vraiment class.
> ca manquait. Docbook est assez repandu, ca genere tout ce qu'il faut.
> (apt-get install conglomerate)
> 
> Ceci dit, avec une doc intra-source, en utilisant phpdocumentator ou
> bien doxygen, ca peut des fois etre tres satisfaisant comme doc
> developpeur. Surtout quand tu commences a utiliser les tags \todo 
> et ce genre de choses.

Je pense qu'il faut les deux, juste une doc intra-source n'est pas
suffisante, et on est tout de meme dans une archi web, surchager le
code de documentation n'a pas la meme implication quand dans un
univers compilé.

Merci je vais regarder conglomerate

A++

-- 
Rodolphe Quiedeville
 Artisan Logiciel Libre - http://rodolphe.quiedeville.org/
      Travaillons Libre - http://fr.lolix.org/
Réseau Libre Entreprise - http://www.libre-entreprise.com/