Accéder au contenu.
Menu Sympa

fr - Comment travailler sur la doc ?

Objet : Pour les administrateurs de serveurs de listes utilisant le logiciel Sympa

Archives de la liste

Chronologique Discussions  
  • From: adresse@cachée (Thierry Pretet)
  • To: adresse@cachée
  • Subject: Comment travailler sur la doc ?
  • Date: Mon, 8 Dec 1997 09:38:10 +0400 (GMT+4)


Bonjour,

Sur le code, la méthode de travail est assez simple :
- je vois un problème -> identification du bug et Mel
- je trouve la correction du bug -> patch et Mel

Pour la documentation, c'est plus compliqué :
- il y a assez peu de "bug" indiscutables ;
- la doc sur www.pasteur.fr semble générée à partir d'un document maître,
sans doute en Word ou en LateX. Les patches n'auraient de sens que sur ce
document maître.

Il me semble nécessaire de commencer par fixer l'organisation de la doc
avant d'aller dans le détail.

Question 1 : Faut-il faire un seul document ?
La documentation utilisateur au milieu de la procédure d'installation, je
trouve çà pas terrible.

Question 2 : Quelle table des matières ?

Après quoi, on travaille par patch ou proposition de modification.

Qu'en pensez-vous ?

--------------------- adresse@cachée --------------------
Centre de Ressource Informatique - Universite de la Reunion
Tel : 0262938303 Fax : 0262938260 From abroad : +262 938303





Archives gérées par MHonArc 2.6.19+.

Haut de le page