Architektur-Anderungsantrage - Archyl Docs

Schlagen Sie Anderungen an Ihrem C4-Modell vor, prufen und mergen Sie diese uber einen strukturierten Anderungsantrags-Workflow

Architektur-Anderungsantrage

Architektur-Anderungsantrage ermoglichen es Ihnen, Modifikationen an Ihrem C4-Modell uber einen strukturierten Review-Workflow vorzuschlagen. Anstatt die Architektur direkt zu bearbeiten, erstellen Teammitglieder Antrage, die gepruft, diskutiert und gemergt werden konnen.

Funktionsweise

Ein Anderungsantrag gruppiert eine oder mehrere vorgeschlagene Anderungen an Ihrem Architekturmodell. Er folgt einem Lebenszyklus ahnlich wie ein Pull Request in Code-Repositories:

  1. Erstellen Sie einen Antrag mit Titel und Beschreibung
  2. Anderungen hinzufugen — C4-Elemente erstellen, aktualisieren oder loschen (Systeme, Container, Komponenten, Code-Elemente, Beziehungen, Overlays)
  3. Zur Prufung offnen wenn der Vorschlag bereit ist
  4. Prufen — Teammitglieder genehmigen, fordern Anderungen an oder hinterlassen Kommentare
  5. Mergen um alle Anderungen auf die Architektur anzuwenden

Lebenszyklus eines Antrags

Jeder Antrag durchlauft diese Status:

Status Beschreibung
Entwurf In Bearbeitung. Nur der Autor kann Anderungen sehen und bearbeiten.
Offen Zur Prufung eingereicht. Teammitglieder konnen prufen und kommentieren.
Genehmigt Hat Genehmigungen erhalten und ist bereit zum Mergen.
Gemergt Anderungen wurden auf das Architekturmodell angewendet.
Geschlossen Abgelehnt oder aufgegeben. Kann vom Autor erneut geoffnet werden.

Einen Antrag erstellen

Uber den Antrage-Tab

  1. Navigieren Sie zu Ihrem Projekt
  2. Offnen Sie den Tab Antrage
  3. Klicken Sie auf Neuer Antrag
  4. Geben Sie einen Titel (max. 200 Zeichen) und eine optionale Beschreibung ein
  5. Der Antrag beginnt im Status Entwurf

Anderungen hinzufugen

Innerhalb eines Entwurfs oder offenen Antrags fugen Sie Anderungen hinzu, indem Sie auswahlen:

  • Operation: Erstellen, Aktualisieren oder Loschen
  • Elementtyp: System, Container, Komponente, Code, Beziehung oder Overlay
  • Elementdaten: Die Eigenschaften des neuen oder geanderten Elements

Anderungen werden nach Operationstyp gruppiert (Erstellungen, Aktualisierungen, Loschungen) zur einfacheren Prufung.

Einen Antrag bearbeiten

Der Autor kann den Titel und die Beschreibung eines Antrags jederzeit bearbeiten, solange er nicht gemergt wurde. Klicken Sie auf das Stift-Symbol neben dem Titel, um in den Bearbeitungsmodus zu wechseln.

Einen Antrag prufen

Eine Prufung einreichen

Teammitglieder mit Bearbeitungszugriff konnen offene Antrage prufen:

  • Genehmigen — der Vorschlag ist zufriedenstellend
  • Anderungen anfordern — Anpassungen sind vor dem Mergen erforderlich
  • Kommentieren — Feedback ohne formelle Entscheidung hinterlassen

Aktivitats-Feed

Der Aktivitats-Tab zeigt alle Prufungen und Kommentare in chronologischer Reihenfolge. Nutzen Sie den Kommentar-Composer unten, um schnelle Kommentare ohne formelle Prufung zu hinterlassen.

Einen Antrag mergen

Wenn ein Antrag gepruft und genehmigt wurde:

  1. Offnen Sie die Detailseite des Antrags
  2. Klicken Sie auf Mergen
  3. Alle Anderungen werden atomar auf das C4-Modell angewendet

Nur Teammitglieder mit Bearbeitungsrechten konnen Antrage mergen.

Anderungen vorab anzeigen

Der Tab Vorschau zeigt eine visuelle Darstellung der Architektur nach Anwendung der Anderungen, damit Prufer die Auswirkungen vor dem Mergen verstehen konnen.

Best Practices

Schreiben Sie klare Titel

Verwenden Sie beschreibende Titel, die die Absicht erklaren:

  • "Payment-Service und Stripe-Integration hinzufugen"
  • "Monolithische API in Benutzer- und Bestell-Services aufteilen"
  • "Veraltete Benachrichtigungs-Komponente entfernen"

Halten Sie Antrage fokussiert

  • Eine logische Anderung pro Antrag
  • Vermeiden Sie das Vermischen unzusammenhangender Modifikationen
  • Kleinere Antrage sind einfacher zu prufen

Verwenden Sie Beschreibungen

Erklaren Sie die Begrundung hinter den vorgeschlagenen Anderungen:

  • Warum diese Architekturanderung notwendig ist
  • Welche Alternativen in Betracht gezogen wurden
  • Links zu zugehorigen ADRs oder Dokumentation

Prufen Sie vor dem Mergen

  • Mindestens eine Genehmigung wird empfohlen
  • Nutzen Sie Kommentare, um Kompromisse zu diskutieren
  • Uberprufen Sie den Vorschau-Tab, um das Ergebnis zu validieren

Nachste Schritte