Grundkonzepte
Diese Seite erklärt die Schlüsselkonzepte, denen Sie bei der Verwendung von Archyl begegnen werden.
Projekte
Ein Projekt ist der oberste Container für Ihre Architektur-Dokumentation. Jedes Projekt repräsentiert ein Software-System oder Produkt, das Sie dokumentieren möchten.
Projekte enthalten:
- Architekturdiagramme (Systeme, Container, Komponenten, Code)
- Beziehungen zwischen Elementen
- Dokumentation und ADRs
- Benutzerflüsse
- Einstellungen und Team-Zugriff
Elemente
Elemente sind die Bausteine Ihrer Architekturdiagramme:
Systeme
Ein System repräsentiert ein Software-System - die höchste Abstraktionsebene. Im C4-Modell ist dies, was Sie dokumentieren.
- Interne Systeme: Systeme, die Sie besitzen und pflegen
- Externe Systeme: Drittsysteme, mit denen Sie interagieren (APIs, SaaS-Produkte)
Container
Ein Container ist eine separat deploybare/ausführbare Einheit, die Code ausführt oder Daten speichert:
- Webanwendungen
- Mobile Apps
- API-Server
- Datenbanken
- Nachrichtenwarteschlangen
- Dateisysteme
Komponenten
Eine Komponente ist eine Gruppierung zusammengehöriger Funktionalität innerhalb eines Containers:
- Controller
- Services
- Repositories
- Module
Code-Elemente
Code repräsentiert die niedrigste Ebene - tatsächliche Code-Konstrukte:
- Klassen
- Interfaces
- Funktionen
- Module
Beziehungen
Beziehungen zeigen, wie Elemente kommunizieren oder voneinander abhängen. Sie beinhalten:
- Ein Label, das die Interaktion beschreibt (z.B. "Liest von", "Sendet Events an")
- Optionale Technologie-Informationen (z.B. "REST/HTTPS", "gRPC", "AMQP")
- Richtung, die den Fluss zeigt
Overlays
Overlays sind visuelle Gruppierungen, die helfen, Ihre Diagramme zu organisieren, ohne die zugrunde liegende Struktur zu ändern. Verwenden Sie sie, um:
- Zusammengehörige Elemente zu gruppieren
- Bestimmte Bereiche hervorzuheben
- Visuelle Grenzen zu erstellen
Ebenen
Archyl verwendet die vier Abstraktionsebenen des C4-Modells:
| Ebene | Zeigt | Zielgruppe |
|---|---|---|
| Systemkontext | Ihr System in seiner Umgebung | Alle |
| Container | Technische Bausteine auf hoher Ebene | Technische Personen |
| Komponente | Komponentenstruktur innerhalb von Containern | Entwickler |
| Code | Details auf Code-Ebene | Entwickler |
Organisationen und Teams
Organisationen
Eine Organisation ist der Arbeitsbereich Ihres Kontos. Sie enthält:
- Alle Ihre Projekte
- Teammitglieder
- Abrechnungsinformationen
- Einstellungen
Teams
Teams helfen, den Zugriff auf Projekte zu organisieren:
- Gruppieren Sie Teammitglieder nach Abteilung, Projekt oder Verantwortung
- Kontrollieren Sie den Zugriff auf bestimmte Projekte
- Verwalten Sie Berechtigungen auf Team-Ebene
Rollen
Archyl hat drei Rollen:
| Rolle | Kann Sehen | Kann Bearbeiten | Kann Verwalten |
|---|---|---|---|
| Betrachter | Ja | Nein | Nein |
| Editor | Ja | Ja | Nein |
| Admin | Ja | Ja | Ja |
KI-Entdeckung
Die KI-Entdeckung ist der Prozess der automatischen Analyse Ihres Quellcodes, um Architektur-Elemente zu entdecken. Sie:
- Verbindet sich mit Ihrem Git-Repository
- Analysiert Code-Struktur und Muster
- Identifiziert Systeme, Container und Komponenten
- Erstellt Beziehungen zwischen Elementen
- Generiert Dokumentationsvorschläge
ADRs
Architecture Decision Records (ADRs) dokumentieren wichtige Architekturentscheidungen:
- Was entschieden wurde
- Warum es entschieden wurde
- Welche Alternativen in Betracht gezogen wurden
- Was die Konsequenzen sind
Flüsse
Benutzerflüsse dokumentieren, wie Benutzer oder Daten sich durch Ihr System bewegen:
- Schritt-für-Schritt-Sequenzen
- Links zu Architektur-Elementen
- Visuelle Flussdiagramme