Relations - Archyl Docs

Apprenez à créer et styliser les relations entre les éléments d'architecture

Relations

Les relations montrent comment les éléments d'architecture communiquent, dépendent ou interagissent entre eux. Elles sont une partie cruciale de la documentation d'architecture.

Créer des Relations

Glisser-Déposer

  1. Survolez l'élément source
  2. Cliquez et faites glisser depuis le point de connexion (petit cercle)
  3. Déposez sur l'élément cible
  4. Une relation est créée automatiquement

Menu Contextuel

  1. Cliquez droit sur l'élément source
  2. Sélectionnez "Créer une Relation"
  3. Cliquez sur l'élément cible

Propriétés des Relations

Label

Le label décrit ce que la relation représente :

  • "Envoie les commandes à"
  • "Lit les données depuis"
  • "S'authentifie via"
  • "Se déploie sur"

Bonnes pratiques :

  • Utilisez la voix active
  • Soyez spécifique sur ce qui circule
  • Restez concis

Technologie

Spécifiez optionnellement la technologie ou le protocole :

  • "REST/HTTPS"
  • "gRPC"
  • "AMQP"
  • "SQL/TCP"
  • "WebSocket"

Direction

Les relations ont une direction indiquée par la flèche :

  • Unidirectionnelle : Communication à sens unique (la plus courante)
  • Bidirectionnelle : Communication dans les deux sens

Styliser les Relations

Style de Ligne

  • Solide : Dépendance directe ou communication
  • Pointillée : Communication optionnelle ou asynchrone

Couleur

Utilisez les couleurs pour catégoriser les relations :

  • Bleu pour le flux de données
  • Vert pour les chemins de succès
  • Rouge pour la gestion des erreurs
  • Gris pour l'optionnel

Courbe vs Droite

  • Lignes courbes : Meilleures pour les diagrammes complexes, évitent les chevauchements
  • Lignes droites : Plus propres pour les diagrammes simples

Patterns Courants

Requête-Réponse

App Web --"Fait des appels API [REST/HTTPS]"--> Serveur API

Événementiel

Service Commandes --"Publie des événements [AMQP]"--> File de Messages
Service Notifications <--"S'abonne aux événements [AMQP]"-- File de Messages

Accès Base de Données

Serveur API --"Lit/écrit des données [SQL/TCP]"--> Base de Données

API Externe

Service Paiement --"Traite les paiements [REST/HTTPS]"--> API Stripe

Relations Inter-Niveaux

Les relations peuvent s'étendre à travers différents conteneurs lors de la visualisation au niveau Composant :

  • Les composants peuvent se connecter à des conteneurs dans d'autres parties du système
  • Cela aide à montrer l'image complète sans quitter la vue actuelle

Conseils

Ne Pas Trop Connecter

Toutes les relations possibles n'ont pas besoin d'être montrées. Concentrez-vous sur :

  • Les flux de données principaux
  • Les dépendances importantes
  • Les connexions non évidentes

Regrouper les Relations Liées

Si plusieurs éléments communiquent de la même manière, envisagez :

  • D'utiliser un intermédiaire (API Gateway, File de Messages)
  • De regrouper avec des overlays

Garder les Labels Lisibles

  • Positionnez les labels pour éviter les chevauchements
  • Utilisez des labels plus courts pour des diagrammes plus propres
  • Ajoutez les détails dans les descriptions des éléments à la place