HaïkoOz


Curious front-end builder, wannabe photographer, despicable anarchist & cynical bastard.


De la nécessité de la documentation

J'ai récemment été confronté à un soucis qui n'a rien de rare et qui emmerde tout nouvel arrivant sur un projet : l'absence de documentation.

Alors je ne vous cache pas que chez mon précédent employeur, tout le monde utilisait les mêmes outils, les mêmes frameworks, etc. Il y avait bien quelques subtilités par projet mais globalement on codait tous avec le même système.
Du coup, la doc était "un peu" superflue. Non pas qu'elle était inutile mais disons qu'on n'avait pas forcément besoin d'aller la lire pour comprendre les subtilités.

Je sais bien que la documentation est une nécessité, qu'il faut se faire violence et l'écrire et qu'il ne faut pas passer à côté quand on reprend un projet. Mais je n'ai jamais vraiment été dans le cas où j'ai souffert de son absence, soit parce que je connaissais déjà tous les outils (comme je l'ai dit plus haut), soit parce qu'on me faisait une bonne passation de projet.

Jamais jusque récemment…

Voyez-vous, j'ai donc, il y a peu, changé d'entreprise. Je suis dans une toute petite boîte de moins de 15 personnes.
Sûrement était-ce dû à la taille justement mais cette nécessité de documentation ne s'est pas fait sentir à la seule et unique personne faisant du front avant que j'arrive.
Honnêtement, je ne la blâme pas, je pense que je serais tombé aussi dans le piège si j'avais été à sa place.

Le fait est que peu de projets historiques ont un tronc commun, beaucoup d'outils ou de frameworks changent et ce qui est une évidence pour celui qui l'a codé l'est beaucoup moins pour celui qui reprend.

Vous pourriez me dire que j'aurais pu demander une passation et c'est ce que j'ai fait la plupart du temps jusqu'au jour où la personne eut la très mauvaise idée de prendre des congés (enfin, mauvaise idée pour moi).
J'ai repris un vieux projet et je n'ai pas compris un poil de cul de comment ce bouzin fonctionnait.
Il y avait bien un readme.md à la racine du projet, quasi vide, ne donnait quasi aucune information…
J'ai donc dû fouiller chaque recoin de chaque dossier et fichier de ce foutu projet pour comprendre.
Ça m'a demandé 4h pour comprendre.
4h pour changer… un logo.

Autant vous dire que ça devait être ma demi-journée la moins productive depuis bien longtemps.

Donc chers amis, de grâce, même si c'est chiant, même si vous avez l'impression de perdre votre temps, et comme le dit mon cher ex-collègue Jérémie Patonnier, dit le Rédacteur Technique de White Chapel, dit le Grizzli du MDN, dit l'abominable homme des docs : faites vos putain de docs, bande d'enfoirés.
Bon, je vous retranscris ça de pèle-mêle aussi...

Et de la part de tous les parachutés sur des projets, MERCI. :)

Photo de Viewminder