Méthodes de documentation
De Freenet Doc.
Sommaire |
[modifier] Efforts de documentations dans le monde libre
Quelques exemples permettant de voir des projets aboutis de documentation pouvant servir de modele.
[modifier] Lignes directrices concernant la redaction
Comment rediger de maniere clair et concise.
[modifier] Aspects technique de la documentation
Comment editer puis diffuser la documentation redigee.
[modifier] Documentation en interne
Le logiciel doit lui aussi etre documente pour les contributeurs, pas seulement les utilisateurs finaux. Dans 6 mois un programmeur se rappelera peut-etre de son idee geniale dans le module X contenan t la classe Z qui optimize l'utilisation specifique de la fonction C de la classe B du module A mais... un nouveau programmeur le comprendra-t-il ?
