Pourquoi la documentation compte ?

D’aucuns trouvent que la doc, c’est la partie fastidieuse du projet. Écrire du texte pour expliquer aux utilisateurs ce qu’on a fait, c’est la corvée pour les développeurs. Les utilisateurs sont pourtant ceux qui donnent la vie à votre logiciel, et ceux qui font votre réputation. Ils ont besoin de savoir comment se servir de votre logiciel. Personne ne veut travailler la documentation, alors que c’est la première chose qui est lue lorsqu’on installe un nouveau projet : du README à la FAQ et aux points de Référence, une bonne documentation est comme une publicité pour votre projet. La documentation donne un aperçu de la qualité de votre projet, elle est une valeur ajoutée. Nous parlerons donc de l’intérêt de la doc, de la génération de documentation, de gérer de la documentation existante, et de comment les développeurs peuvent écrire de la doc sans douleur.