Benutzerflüsse - Archyl Docs

Dokumentieren Sie Benutzer- und Datenflüsse durch Ihre Architektur, um Interaktionssequenzen zu visualisieren

Benutzerflüsse

Benutzerflüsse in Archyl ermöglichen es Ihnen, Interaktionssequenzen durch Ihre Architektur zu dokumentieren. Visualisieren Sie, wie Benutzer, Daten oder Anfragen sich durch Ihr System bewegen.

Was sind Flüsse?

Ein Fluss repräsentiert eine Sequenz von Schritten durch Ihre Architektur:

  • Benutzer-Journeys: Login, Checkout, Registrierung
  • Datenflüsse: Bestellverarbeitung, Datensynchronisation
  • Systeminteraktionen: API-Aufrufe, Ereignisketten
  • Fehlerbehandlung: Fehlerszenarien, Wiederholungsversuche

Jeder Schritt in einem Fluss referenziert Beziehungen in Ihrer Architektur und erstellt eine verbundene Ansicht, wie Dinge funktionieren.

Einen Fluss erstellen

Vom Flüsse-Tab

  1. Gehen Sie zum Flüsse-Tab in Ihrem Projekt
  2. Klicken Sie auf Fluss erstellen
  3. Geben Sie einen Namen und eine Beschreibung ein
  4. Fügen Sie Schritte hinzu, indem Sie Beziehungen auswählen
  5. Klicken Sie auf Speichern

Fluss-Struktur

Jeder Fluss enthält:

Feld Beschreibung
Name Kurzer, beschreibender Name (z.B. "Benutzer-Login-Fluss")
Beschreibung Was dieser Fluss repräsentiert
Schritte Geordnete Liste von Beziehungsreferenzen

Schritte hinzufügen

Für jeden Schritt:

  1. Wählen Sie eine Beziehung aus Ihrer Architektur
  2. Der Schritt zeigt Quelle, Ziel und Beziehungslabel
  3. Ziehen Sie zum Neuordnen der Schritte
  4. Fügen Sie Notizen für zusätzlichen Kontext hinzu

Flüsse anzeigen

Schritt-für-Schritt-Navigation

Beim Anzeigen eines Flusses:

  • Schritte werden in Reihenfolge angezeigt
  • Der aktuelle Schritt wird im Diagramm hervorgehoben
  • Navigieren Sie mit Weiter/Zurück-Buttons
  • Sehen Sie den vollen Kontext bei jedem Schritt

Animierte Wiedergabe

Klicken Sie auf Abspielen, um durch den Fluss zu animieren:

  • Automatische Schrittfortschritt
  • Hervorgehobener Pfad im Diagramm
  • Einstellbare Wiedergabegeschwindigkeit

Flüsse teilen

Öffentliche Fluss-Links

Benutzerflüsse haben eingebautes öffentliches Teilen:

  1. Öffnen Sie einen Fluss
  2. Klicken Sie auf das Teilen-Symbol
  3. Kopieren Sie die öffentliche URL
  4. Teilen Sie mit jedem

Die öffentliche Ansicht enthält:

  • Schritt-für-Schritt-Navigation
  • Architekturvisualisierung
  • Flussbeschreibung
  • Keine Authentifizierung erforderlich

Flüsse einbetten

Betten Sie Flüsse in externe Tools ein:

  • Confluence
  • Notion
  • Dokumentationsseiten
  • Wikis

Best Practices

Flüsse klar benennen

Verwenden Sie handlungsorientierte Namen:

  • "Benutzerregistrierung"
  • "Bestellungs-Checkout-Prozess"
  • "Zahlungsrückerstattungs-Fluss"
  • "Datensynchronisations-Pipeline"

Flüsse fokussiert halten

  • Ein Fluss pro Benutzer-Journey
  • 5-15 Schritte sind ideal
  • Teilen Sie komplexe Flüsse in Sub-Flüsse auf
  • Referenzieren Sie andere Flüsse bei Bedarf

Kontext hinzufügen

Verwenden Sie Beschreibungen um zu erklären:

  • Warum dieser Fluss existiert
  • Wer ihn benutzt
  • Wann er ausgelöst wird
  • Was das erwartete Ergebnis ist

Mit Dokumentation verknüpfen

Referenzieren Sie verwandte Docs:

  • API-Spezifikationen
  • Anforderungsdokumente
  • ADRs, die Designentscheidungen erklären

Beispielflüsse

E-Commerce Checkout

  1. Benutzer → Warenkorb-Service: "Warenkorb anzeigen"
  2. Warenkorb-Service → Inventar: "Verfügbarkeit prüfen"
  3. Benutzer → Checkout-Service: "Checkout beginnen"
  4. Checkout-Service → Zahlung: "Zahlung verarbeiten"
  5. Zahlung → Bestell-Service: "Bestellung erstellen"
  6. Bestell-Service → Benachrichtigung: "Bestätigung senden"

API-Authentifizierung

  1. Client → API-Gateway: "Anfrage mit Credentials"
  2. API-Gateway → Auth-Service: "Token validieren"
  3. Auth-Service → Benutzer-DB: "Benutzer nachschlagen"
  4. Auth-Service → API-Gateway: "Claims zurückgeben"
  5. API-Gateway → Backend: "Mit Benutzerkontext weiterleiten"

Nächste Schritte