Re: Comment travailler sur la doc ?

[Pierre DAVID <adresse@cachée>]

On Mon, Dec 08, 1997 at 09:38:10AM +0400, Thierry Pretet wrote:
> 
> 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.
>

doc/sympa.sgml

> 
> 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.
>

S'il s'agit de la partie "Reqûetes administratives pour l'utilisateur",
il ne s'agit pas de la "documentation utilisateur", mais du minimum pour
que l'administrateur puisse gérer une liste et aider les utilisateurs.
C'est donc bien une partie "documentation administrateur".

> 
> Question 2 : Quelle table des matières ?
> 
> Après quoi, on travaille par patch ou proposition de modification.
> 

S'il y a une restructuration de la table des matières, cela nécessitera
autre chose que des patches.

Pierre
-- 
UNIX _IS_ user friendly.  It's just selective about who its friends are.