4. Le contenu de votre documentation

Si vous avez suivi cet article, que vous voulez le mettre en pratique, mais que vous n'avez pas encore trop d'idées de contenu pour votre documentation, en voici. Faites au moins un chapitre sur comment compiler/installer le programme. En général, comme il s'agit juste de la séquence ./configure; make; make install, il n'y a que cela à spécifier. Mais il faut le dire.

Vous pouvez aussi démarrer le squelette d'une FAQ. Et qui sait, certaines questions ont déjà été posées par des utilisateurs, voire par vous Mais comment j'ai fait l'autre fois pour...

Et puis il vous reste à démarrer la documentation du programme : comment le lancer, description de ce qu'il fait, etc. Vous pouvez aussi distinguer une documentation pour l'utilisateur qui veut démarrer, donc une documentation typiquement courte, et une autre plus longue, dite de référence. Commencez peut-être par un seul document, et quand il devient gros, vous le découpez en deux, trois, voire quatre documents distincts. Le projet Postgresql par exemple dispose de huit documents pour sa version 7.3 !

création est mise à disposition sous un contrat Creative Commons