50 000 mots de documentation logicielle
Rédigé 50 000 mots de documentation logicielle complète en Markdown dans GitHub, Craft et Confluence pour conserver les connaissances et rendre le processus transparent.
2022 – 2024
Situation. L’essentiel du savoir sur le produit et le fonctionnement de l’équipe vivait dans les têtes. Cela convient jusqu’au jour où quelqu’un arrive ou part — l’intégration devient alors laborieuse, et une partie de la mémoire de l’organisation risque de disparaître définitivement à la prochaine démission.
Tâche. L’objectif était d’extraire ce savoir des têtes pour en faire une documentation réellement conservée et utilisée : assez claire pour être lue, assez structurée pour être maintenue plutôt qu’abandonnée au bout d’un mois.
Action. Une grande partie a été rédigée à la main, environ 50 000 mots au total, en Markdown dans GitHub, Craft et Confluence selon la place de chaque élément. Elle couvrait l’architecture, les processus et les modes d’emploi pratiques — les questions que les gens posaient sans cesse. Elle était versionnée et, tout aussi essentiel, facile à trouver, car une documentation introuvable pourrait tout aussi bien ne pas exister.
Résultat. Le savoir a cessé d’être fragile. Les nouvelles recrues devenaient opérationnelles plus vite, le processus devenait une référence consultable plutôt qu’un récit à reconstruire de mémoire, et l’ensemble devenait auditable : il était possible de voir comment et pourquoi le travail était réalisé, au lieu de devoir le croire sur parole.