Tous les cas d’usage
Ingénierie plateforme
Une documentation fausse dans la pull request, pas en production
TechDocs construite depuis le dépôt, publiée à côté du service qu’elle décrit.
Avant Fenwave14 mois d’attente
“Ce runbook est-il encore juste ? Dernière modification il y a 14 mois par quelqu’un qui est parti”
Ce que coûte l’attente
Une documentation rangée loin du code se dégrade en silence, et reste crue jusqu’à l’incident où elle compte.
Les TechDocs s’écrivent en Markdown dans le dépôt et sont publiées sur la fiche catalogue du service. Documentation et code voyagent dans la même pull request : un relecteur voit qu’un changement a rendu le runbook faux — au seul moment où le corriger est peu coûteux.
Comment ça marche
- 01Rédigez la documentation en Markdown à côté du code.
- 02Fenwave la construit et la publie sur la fiche catalogue.
- 03Les lecteurs la trouvent depuis le service, pas via une recherche wiki séparée.
- 04Les modifications de documentation sont relues avec le code qui les motive.