Aller au contenu

La doc, c’est de l’infrastructure

Pour moi, la documentation, c’est de l’infrastructure.

Il faut qu’il y en ait assez dans votre projet, et dans votre code, pour répondre au qui, quoi, où, quand et pourquoi de tout.

Je parle des dépôts de code, des tickets, des pages Confluence et oui — même des serviettes à cocktail dans vos tiroirs de bureau. Parce que vous n’êtes pas désorganisés. Au contraire, vous l’êtes beaucoup. Les serviettes avec du pseudo-code taché de café, c’est juste comme ça que votre génie se pointe au boulot.

Aussi : les petits carnets jaunes. Les post-it. Les messages que vous vous envoyez sur Slack et que personne d’autre ne comprend.

Oui.

Le format importe moins que l’habitude. La doc n’est pas optionnelle. Ça fait partie de la religion.

Vous priez à l’autel du cycle de développement implacable.

Vous suivez le commandement :
« Tu écriras ce que tu penses et ce que tu prévois, quelque part.
De préférence près du code. Mais quelque part. »

Parce que c’est ça, la rétention de contexte :
Toutes les choses dont vous pourriez ne pas vous souvenir demain, mais qui seront absolument cruciales dans 6 mois.

Si vous ne faites pas ça... vous allez vous prendre un mur --- et c’est vous-même qui l’aurez construit.