Concepts Fondamentaux
Cette page explique les concepts clés que vous rencontrerez en utilisant Archyl.
Projets
Un Projet est le conteneur de premier niveau pour votre documentation d'architecture. Chaque projet représente un système logiciel ou un produit que vous souhaitez documenter.
Les projets contiennent :
- Des diagrammes d'architecture (Systèmes, Conteneurs, Composants, Code)
- Des relations entre les éléments
- De la documentation et des ADRs
- Des flux utilisateurs
- Des paramètres et accès d'équipe
Éléments
Les éléments sont les blocs de construction de vos diagrammes d'architecture :
Systèmes
Un Système représente un système logiciel - le plus haut niveau d'abstraction. Dans le modèle C4, c'est ce que vous documentez.
- Systèmes Internes : Systèmes que vous possédez et maintenez
- Systèmes Externes : Systèmes tiers avec lesquels vous interagissez (APIs, produits SaaS)
Conteneurs
Un Conteneur est une unité déployable/exécutable séparément qui exécute du code ou stocke des données :
- Applications web
- Applications mobiles
- Serveurs API
- Bases de données
- Files de messages
- Systèmes de fichiers
Composants
Un Composant est un regroupement de fonctionnalités liées au sein d'un conteneur :
- Contrôleurs
- Services
- Repositories
- Modules
Éléments de Code
Le Code représente le niveau le plus bas - les constructions de code réelles :
- Classes
- Interfaces
- Fonctions
- Modules
Relations
Les Relations montrent comment les éléments communiquent ou dépendent les uns des autres. Elles incluent :
- Un libellé décrivant l'interaction (ex : "Lit depuis", "Envoie des événements à")
- Des informations optionnelles sur la technologie (ex : "REST/HTTPS", "gRPC", "AMQP")
- La direction montrant le flux
Overlays
Les Overlays sont des regroupements visuels qui aident à organiser vos diagrammes sans changer la structure sous-jacente. Utilisez-les pour :
- Regrouper des éléments liés
- Mettre en évidence des zones spécifiques
- Créer des frontières visuelles
Niveaux
Archyl utilise les quatre niveaux d'abstraction du modèle C4 :
| Niveau | Montre | Audience |
|---|---|---|
| Contexte Système | Votre système dans son environnement | Tout le monde |
| Conteneur | Blocs techniques de haut niveau | Personnes techniques |
| Composant | Structure des composants dans les conteneurs | Développeurs |
| Code | Détails au niveau du code | Développeurs |
Organisations et Équipes
Organisations
Une Organisation est l'espace de travail de votre compte. Elle contient :
- Tous vos projets
- Les membres d'équipe
- Les informations de facturation
- Les paramètres
Équipes
Les Équipes aident à organiser l'accès aux projets :
- Regroupez les membres par département, projet ou responsabilité
- Contrôlez l'accès à des projets spécifiques
- Gérez les permissions au niveau de l'équipe
Rôles
Archyl a trois rôles :
| Rôle | Peut Voir | Peut Éditer | Peut Administrer |
|---|---|---|---|
| Lecteur | Oui | Non | Non |
| Éditeur | Oui | Oui | Non |
| Admin | Oui | Oui | Oui |
Découverte IA
La Découverte IA est le processus d'analyse automatique de votre code source pour découvrir les éléments d'architecture. Elle :
- Se connecte à votre dépôt Git
- Analyse la structure et les patterns du code
- Identifie les systèmes, conteneurs et composants
- Crée des relations entre les éléments
- Génère des suggestions de documentation
ADRs
Les Architecture Decision Records (ADRs) documentent les décisions d'architecture importantes :
- Ce qui a été décidé
- Pourquoi cela a été décidé
- Quelles alternatives ont été considérées
- Quelles sont les conséquences
Flux
Les Flux Utilisateurs documentent comment les utilisateurs ou les données se déplacent dans votre système :
- Séquences étape par étape
- Liens vers les éléments d'architecture
- Diagrammes de flux visuels