Bonjour à tous,

Il y a un article dans le dernier magazine Red Hat à propos de la documentation qui est un très bon résumé du processus dans lequel entre une documentation réussie. Je voudrais recommander qu'on en exige la lecture pour tous ceux qui sont intéressés par la documentation.

Quelques points ont fait ce sont particulièrement important pour la doc de PEAR :

1) manque de clarté dans la documentation souvent = manque de compréhension de ce que vous documentez, même si vous écriviez la chose.
2) être un expert n'est pas toujours nécessaire de écrire de bonnes doc.
3) mettre trop d'espoir dans le fait que les utilisateurs connaissent déjà tout est dangereux pour une documentation

Nous dépensons beaucoup d'énergie dans PEAR essayant d'obliger des auteurs/développeurs à écrire des documentations pour leurs paquets, mais ce n'est qu'une première étape.

Nous devons impliquer les utilisateurs de manière à ce que leurs réactions puissent être employées pour raffiner la documentation existante plus aisément.

De toute façon, voici l'article : Greg