Zenika
Technozaure

Documentation as Code as Documentation

Salle : Chez Marius à

Catégorie : 🛠 Craft

Au commencement étaient les devs. Et les devs devaient documenter leur code. Et les devs virent que ce n'était pas bon.

Le deuxième jour, les devs ont décidé de faire des tests car ces tests étaient bien plus faciles à écrire que de la prose et la cohérence avec le code était vérifiable automatiquement. Et les devs virent que c'était déjà mieux.

Un jour comme ça, des devs ont cherché la documentation et ne l'ont point trouvé. Ces devs ont regardé les tests et n'ont toujours point trouvé l'information recherchée. Ces devs ont décidé d'écrire de la documentation. Et les devs virent le serpent se mordre la queue.

Mais cette documentation n'était pas comme les autres. Elle était 100% test et 100% documentation. Elle permettait aux exemples de code d'être à jour et d'être expliqués par un peu de texte.

Regarde, qui a des yeux pour regarder du live coding de documentation. Entende, qui a des oreilles pour écouter des justifications de ce genre de pratique.