La plupart des docs tournent vite obsolètes parce qu'elles sont séparées du code. Je lie la documentation aux commits, aux PRs et aux tickets produit.
Mon quotidien
- Je donne une template simple : contexte, configuration, commandes de démarrage, pièges connus.
- Cette template est toujours ajoutée à la PR qui modifie la fonctionnalité.
- Je génère la doc avec
npx(ex:npx updates-docs) ou je synchronise automatiquement depuis Notion si besoin.
Ainsi, la doc évolue en même temps que le code, et l'équipe n'a plus besoin de deviner les paramètres. Elle peut suivre l'historique et revenir à une version précise du doc grâce aux commits.