Method & Tools

Architecture Decision Records: Réconciliez vous avec votre documentation

Débutant
Quickie

Les développeurs aiment écrire de la documentation… ou pas ! Pourtant même les plus réfractaires doivent l’admettre, garder une trace des décisions techniques prises au cours d’un projet peut s’avérer indispensable pour la pérennité et maintenabilité de celui-ci.

Alors comment éviter l’obsolescence programmée de la documentation, tout en réduisant la pénibilité de la rédaction ?

Depuis près d’un an, dans “mon” équipe, nous utilisons un format simple, les Architecture Decision Records (ADRs), pour écrire des documents d’architecture sous la forme d’un journal immuable. Cette technique simple gagne en popularité et a donné de bons résultats sur notre projet.

Durant cette présentation vous construirez en direct un ADR. En partant d’un problème constaté sur un projet, vous élaborerez une réponse technique qui servira de base à une implémentation ultérieure. Vous décrirez les raisons qui vous poussent à faire des compromis, tout en capturant le contexte dans lequel cette décision a été prise pour référence future.

Réconciliez vous avec votre documentation !