Erfahren Sie, wie Archyl KI verwendet, um Ihre Architektur automatisch aus Ihrer Codebasis zu entdecken und zu dokumentieren

KI-gestützte Entdeckung

Die KI-Entdeckungsfunktion von Archyl analysiert Ihre Codebasis, um Ihre Softwarearchitektur automatisch zu entdecken und zu dokumentieren. Dies spart Stunden manueller Dokumentationsarbeit und stellt sicher, dass Ihre Architekturdokumentation mit Ihrem tatsächlichen Code synchron bleibt.

So funktioniert es

1. Verbinden Sie Ihr Repository

Verbinden Sie zunächst Ihr Git-Repository mit Archyl:

Gehen Sie zu Ihren Projekteinstellungen
Klicken Sie auf "Repository verbinden"
Wählen Sie Ihren Git-Anbieter (GitHub, GitLab, Bitbucket, etc.)
Autorisieren Sie Archyl für den Zugriff auf Ihr Repository

2. Starten Sie die Entdeckung

Nach der Verbindung starten Sie die KI-Entdeckung:

Klicken Sie auf "Entdeckung starten" in Ihrem Projekt
Wählen Sie die zu analysierenden Branches oder Pfade
Konfigurieren Sie Entdeckungseinstellungen (optional)
Klicken Sie auf "Entdeckung ausführen"

3. KI-Analyse

Die KI analysiert Ihre Codebasis zur Identifizierung von:

Projektstruktur: Frameworks, Sprachen, Build-Systeme
Services: Microservices, APIs, Hintergrund-Worker
Datenspeicher: Datenbanken, Caches, Dateispeicher
Externe Integrationen: Drittanbieter-APIs, SaaS-Dienste
Komponenten: Module, Pakete, Schlüsselklassen
Beziehungen: Wie Komponenten kommunizieren

4. Überprüfen & Genehmigen

Entdeckungen werden in einem "Ausstehend"-Status zur Überprüfung platziert:

Überprüfen Sie jedes entdeckte Element
Bearbeiten Sie Namen, Beschreibungen oder Beziehungen
Genehmigen Sie genaue Entdeckungen
Lehnen Sie ungenaue ab oder ändern Sie sie

Unterstützte Technologien

KI-Entdeckung funktioniert am besten mit:

Sprachen

JavaScript/TypeScript
Python
Go
Java
C#
Ruby
PHP
Rust

Frameworks

React, Next.js, Vue, Angular
Express, Fastify, NestJS
Django, Flask, FastAPI
Spring Boot
ASP.NET Core
Ruby on Rails

Infrastruktur

Docker/Kubernetes
Terraform
AWS CDK
Cloud-Konfigurationsdateien

Inkrementelle Entdeckung

Die inkrementelle Entdeckung haelt Ihr C4-Modell aktuell, indem sie nur die geaenderten Dateien analysiert — nicht das gesamte Repository. Dies ist schneller, kostenguenstiger und kann automatisch bei jedem Push ausgefuehrt werden.

Funktionsweise

Code wird auf den Default-Branch gepusht
Archyl empfaengt das Push-Event (ueber Webhook oder GitHub Action)
Geaenderte Dateien werden aus den Commits extrahiert
Nur Quelldateien werden analysiert (geloeschte Dateien werden uebersprungen)
Die KI wird auf der kleineren Dateimenge ausgefuehrt
Neue Elemente werden als ausstehende Entdeckungen erstellt
Bestehende Elemente werden automatisch dedupliziert

Inkrementelle Entdeckung aktivieren

Es gibt zwei Moeglichkeiten, die inkrementelle Entdeckung zu aktivieren:

GitHub Webhook — Aktivieren Sie Discovery on Push in den Webhook-Einstellungen Ihres Projekts
GitHub Action (CI/CD) — Fuegen Sie die Archyl Incremental Discovery Action zu Ihrem Workflow hinzu. Siehe GitHub Actions Integration fuer vollstaendige Anweisungen.

name: Architecture Sync
on:
  push:
    branches: [main]

jobs:
  discovery:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 2
      - uses: archyl/archyl/.github/actions/incremental-discovery@main
        with:
          api-key: ${{ secrets.ARCHYL_API_KEY }}
          project-id: ${{ vars.ARCHYL_PROJECT_ID }}

Vollstaendige vs. inkrementelle Entdeckung

	Vollstaendige Entdeckung	Inkrementelle Entdeckung
Umfang	Gesamtes Repository	Nur geaenderte Dateien
Trigger	Manuell (UI/API)	Automatisch (Webhook oder GitHub Action)
Geschwindigkeit	Minuten (abhaengig von der Repository-Groesse)	Sekunden bis Minuten
KI-Kosten	Hoeher (analysiert alle Dateien)	Niedriger (analysiert nur den Diff)
Anwendungsfall	Ersteinrichtung, groessere Refactorings	Taegliche Codeanderungen

Best Practices

Klein anfangen

Für große Codebasen:

Beginnen Sie mit einem einzelnen Service oder Modul
Überprüfen und verfeinern Sie die Ergebnisse
Erweitern Sie schrittweise auf andere Bereiche

Regelmäßige Aktualisierungen

Halten Sie Ihre Dokumentation aktuell:

Führen Sie die Entdeckung nach größeren Änderungen aus
Überprüfen Sie neue ausstehende Entdeckungen
Aktualisieren Sie bestehende Elemente nach Bedarf

Mit Manuellem kombinieren

KI-Entdeckung ist ein Ausgangspunkt:

Nutzen Sie KI für die Hauptarbeit
Fügen Sie Geschäftskontext manuell hinzu
Verfeinern Sie Beziehungen und Beschreibungen

Fehlerbehebung

Entdeckung dauert zu lange

Reduzieren Sie Nebenläufigkeitseinstellungen
Schließen Sie große Verzeichnisse aus (node_modules, vendor)
Konzentrieren Sie sich auf bestimmte Pfade

Ungenaue Ergebnisse

Überprüfen und korrigieren Sie laufend
Die KI lernt aus Ihren Korrekturen
Mehr Kontext in Code-Kommentaren hilft

KI-gestützte Entdeckung - Archyl Docs