• [^] # Re: Peut-être que les développeurs bossent à l'envers ?

    Posté par (site web personnel, Mastodon) . En réponse à la dépêche Calenco : une solution pour la documentation des projets libres ?. Évalué à 2.

    C'est clair qu'avoir seulement quelques commentaires dans le code n'aide pas à attirer de nouveaux développeurs. Même s'il y a beaucoup de commentaires, il n'est parfois pas facile de comprendre la structure générale du code, et on ne sait pas vraiment par où commencer la lecture (le main() est toutefois un bon point de départ, généralement).

    Mais écrire d'abord la documentation (pour développeurs) avant le code, ça me parait une perte de temps si on s'aperçoit en codant qu'on n'a pas prévu tous les cas possibles et où une réécriture en profondeur de la documentation est nécessaire...

    Pour ce qui est de la documentation pour utilisateurs, autant le faire après le code pour pouvoir insérer des captures d'écran, faire référence à telle ou telle option bien spécifique dans les préférences, etc.