Découverte Propulsée par l'IA - Archyl Docs

Découvrez comment Archyl utilise l'IA pour découvrir et documenter automatiquement votre architecture à partir de votre code

Découverte Propulsée par l'IA

La fonctionnalité de Découverte IA d'Archyl analyse votre code source pour découvrir et documenter automatiquement votre architecture logicielle. Cela économise des heures de travail de documentation manuel et garantit que votre documentation d'architecture reste synchronisée avec votre code réel.

Comment Ça Fonctionne

1. Connectez Votre Dépôt

D'abord, connectez votre dépôt Git à Archyl :

  1. Allez dans les paramètres de votre projet
  2. Cliquez sur "Connecter un Dépôt"
  3. Choisissez votre fournisseur Git (GitHub, GitLab, Bitbucket, etc.)
  4. Autorisez Archyl à accéder à votre dépôt

2. Démarrez la Découverte

Une fois connecté, lancez la découverte IA :

  1. Cliquez sur "Démarrer la Découverte" dans votre projet
  2. Sélectionnez les branches ou chemins à analyser
  3. Configurez les paramètres de découverte (optionnel)
  4. Cliquez sur "Lancer la Découverte"

3. Analyse IA

L'IA analyse votre code source pour identifier :

  • Structure du projet : Frameworks, langages, systèmes de build
  • Services : Microservices, APIs, workers en arrière-plan
  • Magasins de données : Bases de données, caches, stockage de fichiers
  • Intégrations externes : APIs tierces, services SaaS
  • Composants : Modules, packages, classes clés
  • Relations : Comment les composants communiquent

4. Réviser & Approuver

Les découvertes sont placées dans un état "En attente" pour révision :

  1. Révisez chaque élément découvert
  2. Modifiez les noms, descriptions ou relations
  3. Approuvez les découvertes précises
  4. Rejetez ou modifiez celles qui sont incorrectes

Technologies Supportées

La Découverte IA fonctionne mieux avec :

Langages

  • 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

Infrastructure

  • Docker/Kubernetes
  • Terraform
  • AWS CDK
  • Fichiers de configuration cloud

Decouverte incrementale

La decouverte incrementale maintient votre modele C4 a jour en analysant uniquement les fichiers modifies — pas l'ensemble du depot. C'est plus rapide, moins couteux, et peut s'executer automatiquement a chaque push.

Fonctionnement

  1. Du code est pousse sur la branche par defaut
  2. Archyl recoit l'evenement push (via webhook ou GitHub Action)
  3. Les fichiers modifies sont extraits des commits
  4. Seuls les fichiers source sont analyses (les fichiers supprimes sont ignores)
  5. L'IA s'execute sur le sous-ensemble de fichiers
  6. Les nouveaux elements sont crees comme decouvertes en attente
  7. Les elements existants sont automatiquement dedupliques

Activer la decouverte incrementale

Il y a deux facons d'activer la decouverte incrementale :

  • Webhook GitHub — Activez Discovery on Push dans les parametres webhook de votre projet
  • GitHub Action (CI/CD) — Ajoutez l'action Archyl Incremental Discovery a votre workflow. Voir Integration GitHub Actions pour les instructions completes.
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 }}

Decouverte complete vs incrementale

Decouverte complete Decouverte incrementale
Portee Depot entier Fichiers modifies uniquement
Declencheur Manuel (UI/API) Automatique (webhook ou GitHub Action)
Vitesse Minutes (selon la taille du depot) Secondes a minutes
Cout IA Plus eleve (analyse tous les fichiers) Plus bas (analyse uniquement le diff)
Cas d'usage Configuration initiale, refactoring majeur Modifications de code quotidiennes

Bonnes Pratiques

Commencez Petit

Pour les grandes bases de code :

  1. Commencez avec un seul service ou module
  2. Révisez et affinez les résultats
  3. Étendez progressivement aux autres zones

Mises à Jour Régulières

Gardez votre documentation à jour :

  1. Lancez la découverte après des changements majeurs
  2. Révisez les nouvelles découvertes en attente
  3. Mettez à jour les éléments existants si nécessaire

Combinez avec le Manuel

La Découverte IA est un point de départ :

  1. Utilisez l'IA pour le gros du travail
  2. Ajoutez le contexte métier manuellement
  3. Affinez les relations et descriptions

Dépannage

La Découverte Prend Trop de Temps

  • Réduisez les paramètres de concurrence
  • Excluez les grands répertoires (node_modules, vendor)
  • Concentrez-vous sur des chemins spécifiques

Résultats Inexacts

  • Révisez et corrigez au fur et à mesure
  • L'IA apprend de vos corrections
  • Plus de contexte dans les commentaires de code aide