Pourquoi faire une documentation (avec quelques idées de contenu)

Vous êtes chargé de nourrir une équipe de 5 personnes en préparant une omelette aux champignons. Vous devez aller cueillir les-dits champignons en forêt, il vous en faut quelques kilos et vous n’y connaissez rien en terme de comestibilité (ni toxicité). Prendriez-vous un livre sur le sujet ?

Il est fréquent de constater que dans le milieu professionnel on recommande de demander aux personnes qui s’y connaissent où de trouver par soi même. On vous demande donc de partir en forêt avec une équipe, voir tout le village, pour savoir quel champignon cueillir et ceux à éviter. Si ils n’ont pas la réponse il suffira de faire goûter un extrait à quelqu’un pour en déterminer la nocivité (modification de code à l’aveugle).

La documentation d’un projet est souvent négligée au point de devoir en référer aux personnes ayant contribué au code ou, quand elles sont absente/parties, comprendre par vous même. Ce comportement peut entrainer un mauvais usage des fonctions existantes ou la création de régression. Pourtant elle est tout aussi importante que les tests sur un projet logiciel et même si on la comprend dans le bagage qualité, rangé au niveau facultatif faute de temps, elle est d’un avis plus personnel, inhérente au développement.

Lire la suite