Accueil › Architecture & design patterns › Le diagramme utile et celui qui ment
Le diagramme utile et celui qui ment
Documenter les décisionsavance
Un diagramme d'architecture est une affirmation sur le système. Comme toute affirmation, il peut être faux — et il le devient tout seul, à chaque livraison qui ne le met pas à jour.
Un schéma absent oblige à lire le code. Un schéma faux dispense de le lire. C'est pourquoi le second coûte plus cher.
Trois règles rendent un diagramme utile.
- Un seul niveau de zoom. Soit le système et ses voisins, soit les déployables, soit les composants d'un déployable. Un schéma qui mélange une base de données, un module et une équipe ne se lit pas.
- Des flèches orientées, avec un sens déclaré. « Appelle », « dépend de », « publie vers ». Une flèche sans verbe laisse chacun lire ce qu'il veut.
- Une date et une portée. « État au 12 mars, périmètre commandes ». Le lecteur sait alors ce qu'il tient.
// Un schéma se vérifie : il déclare des dépendances, le code en a d'autres.
const declarees = [["web", "api"], ["api", "base"]];
const reelles = [["web", "api"], ["api", "base"], ["web", "base"]];
// L'écart « web->base » est précisément ce que le schéma cachait.
Le meilleur diagramme est celui qu'on ne dessine pas : produit depuis le code ou la configuration, il ne peut pas diverger. À défaut, un schéma dessiné reste utile s'il est petit, daté, et si on accepte qu'il soit jetable.
Les termes à connaître
- Diagramme qui ment
Un schéma dont les composants ou les flèches ne correspondent plus au code. Il est plus nuisible qu'un schéma absent, car on le croit.
- Niveau de zoom
L'échelle d'un diagramme : le système dans son environnement, ses déployables, les composants d'un déployable. Mélanger deux niveaux rend le schéma illisible.
- Flèche orientée
Une flèche doit dire qui appelle qui, ou qui dépend de qui — jamais les deux sens à la fois, jamais « est lié à ».
- Diagramme dérivé
Un schéma produit depuis le code ou la configuration. Il ne ment pas, parce qu'il n'a pas d'existence indépendante.
- Légende
La convention qui dit ce que signifient les formes, les traits et les couleurs. Sans elle, chaque lecteur invente la sienne.
- Dérive du schéma
L'écart qui se creuse entre un diagramme dessiné à la main et le système réel, à chaque livraison qui ne met pas le schéma à jour.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.