Flux Utilisateur - Archyl Docs

Documentez les flux utilisateur et de données à travers votre architecture pour visualiser les séquences d'interactions

Flux Utilisateur

Les Flux Utilisateur dans Archyl vous permettent de documenter des séquences d'interactions à travers votre architecture. Visualisez comment les utilisateurs, les données ou les requêtes se déplacent dans votre système.

Qu'est-ce que les Flux ?

Un Flux représente une séquence d'étapes à travers votre architecture :

  • Parcours utilisateur : Connexion, paiement, inscription
  • Flux de données : Traitement de commande, synchronisation de données
  • Interactions système : Appels API, chaînes d'événements
  • Gestion des erreurs : Scénarios d'échec, retentatives

Chaque étape d'un flux référence des relations dans votre architecture, créant une vue connectée de comment les choses fonctionnent.

Créer un Flux

Depuis l'Onglet Flux

  1. Allez dans l'onglet Flux de votre projet
  2. Cliquez sur Créer un Flux
  3. Entrez un nom et une description
  4. Ajoutez des étapes en sélectionnant des relations
  5. Cliquez sur Enregistrer

Structure du Flux

Chaque flux contient :

Champ Description
Nom Nom court et descriptif (ex : "Flux de Connexion Utilisateur")
Description Ce que ce flux représente
Étapes Liste ordonnée de références aux relations

Ajouter des Étapes

Pour chaque étape :

  1. Sélectionnez une relation de votre architecture
  2. L'étape montre la source, la cible et le label de la relation
  3. Glissez pour réordonner les étapes
  4. Ajoutez des notes pour du contexte supplémentaire

Visualiser les Flux

Navigation Étape par Étape

Lors de la visualisation d'un flux :

  • Les étapes sont affichées dans l'ordre
  • L'étape actuelle est mise en évidence sur le diagramme
  • Naviguez avec les boutons Suivant/Précédent
  • Voyez le contexte complet à chaque étape

Lecture Animée

Cliquez sur Lecture pour animer le flux :

  • Progression automatique des étapes
  • Chemin mis en évidence sur le diagramme
  • Vitesse de lecture ajustable

Partager les Flux

Liens de Flux Publics

Les Flux Utilisateur ont un partage public intégré :

  1. Ouvrez un Flux
  2. Cliquez sur l'icône Partager
  3. Copiez l'URL publique
  4. Partagez avec n'importe qui

La vue publique inclut :

  • Navigation étape par étape
  • Visualisation de l'architecture
  • Description du flux
  • Aucune authentification requise

Intégrer les Flux

Intégrez les flux dans des outils externes :

  • Confluence
  • Notion
  • Sites de documentation
  • Wikis

Bonnes Pratiques

Nommez les Flux Clairement

Utilisez des noms orientés action :

  • "Inscription Utilisateur"
  • "Processus de Paiement"
  • "Flux de Remboursement"
  • "Pipeline de Synchronisation de Données"

Gardez les Flux Focalisés

  • Un flux par parcours utilisateur
  • 5-15 étapes est idéal
  • Divisez les flux complexes en sous-flux
  • Référencez d'autres flux quand nécessaire

Ajoutez du Contexte

Utilisez les descriptions pour expliquer :

  • Pourquoi ce flux existe
  • Qui l'utilise
  • Quand il est déclenché
  • Quel est le résultat attendu

Liez à la Documentation

Référencez les docs liés :

  • Spécifications API
  • Documents de requirements
  • ADRs expliquant les choix de conception

Exemples de Flux

Paiement E-commerce

  1. Utilisateur → Service Panier : "Voir le panier"
  2. Service Panier → Inventaire : "Vérifier disponibilité"
  3. Utilisateur → Service Paiement : "Commencer le paiement"
  4. Service Paiement → Paiement : "Traiter le paiement"
  5. Paiement → Service Commande : "Créer la commande"
  6. Service Commande → Notification : "Envoyer confirmation"

Authentification API

  1. Client → API Gateway : "Requête avec credentials"
  2. API Gateway → Service Auth : "Valider le token"
  3. Service Auth → DB Utilisateur : "Rechercher l'utilisateur"
  4. Service Auth → API Gateway : "Retourner les claims"
  5. API Gateway → Backend : "Transférer avec contexte utilisateur"

Prochaines Étapes