Living Documentation

La documentation se périme.
Sauf quand elle se compile avec le code.

HexaGlue produit une documentation vivante de votre modèle de domaine à chaque compilation. Elle reflète l'état réel de votre architecture, pas l'intention d'un document écrit il y a 6 mois.

Contenu généré

L'inventaire complet de votre architecture

La living documentation couvre tous les éléments classifiés par HexaGlue. Elle donne une vue structurée de votre domaine sans effort de rédaction.

Agrégats

Liste des agrégats avec leurs entités, value objects et identifiants associés

Entités et Value Objects

Inventaire avec champs, types, rôles détectés

Ports

Driving ports (interfaces entrantes) et driven ports (interfaces sortantes) avec leur type (Repository, Gateway, EventPublisher)

Services applicatifs

Services et leur câblage avec les ports

Relations

Composition, référence et dépendances entre types

Topologie des modules

En multi-module, répartition des types par module et rôle architectural

Capture d'écran de la living documentation générée par HexaGlue montrant l'inventaire du domaine

Living documentation HexaGlue : agrégat Account avec ses propriétés, identity details et niveau de confiance — Extrait d'une living documentation : détail d'un agrégat et de ses propriétés

Living documentation HexaGlue : ports driving (ManagingAccounts) et driven (AccountRepository, AccountNotifier) avec signatures de méthodes — Extrait d'une living documentation : driving ports et driven ports avec leurs méthodes

Living documentation HexaGlue : topologie des modules avec rôles architecturaux et nombre de types par module — Extrait d'une living documentation : topologie des modules d'un projet multi-module

La living documentation est générée dès le premier mvn compile avec le plugin activé. Pas besoin d'attendre que le projet soit parfaitement structuré : elle documente l'état réel, y compris les types non classifiés. C'est un outil de diagnostic autant que de documentation.

Synchronisation

Le problème de la documentation manuelle

La documentation d'architecture vieillit dès le premier commit après sa rédaction. Les diagrammes Confluence décrivent l'architecture cible, pas l'architecture réelle. Les wikis accumulent des pages obsolètes que personne n'ose supprimer.

Avec HexaGlue, la documentation est régénérée à chaque mvn compile. Elle reflète exactement ce que le code contient à cet instant. Si un développeur ajoute un agrégat, il apparaît dans la documentation au prochain build. Si un port est supprimé, il disparaît.

La living documentation complète l'audit : l'audit dit CE QUI NE VA PAS dans votre architecture, la documentation montre CE QUI EXISTE. Ensemble, ils donnent une vision complète : état des lieux + diagnostic.

Living documentation HexaGlue : diagramme Mermaid des dépendances entre couches, orientées vers le domaine — Extrait d'une living documentation : diagramme des dépendances généré automatiquement

Sortie

Markdown par défaut, intégrable partout

La documentation est générée en Markdown et est enrichie de graphiques et de diagrammes. Ce format est lisible directement sur GitHub, GitLab et intégrable dans un site statique (Docusaurus, MkDocs, Astro), ou convertible en PDF. Les options de sortie sont décrites dans la documentation de configuration.

plugins:
  io.hexaglue.plugin.livingdoc:
    outputDir: "living-doc"              # Répertoire de sortie (défaut)
    generateDiagrams: true               # Diagrammes Mermaid (défaut)
    maxPropertiesInDiagram: 5            # Propriétés max par classe (défaut)
    includeDebugSections: true           # Sections de debug (défaut)

Votre documentation d'architecture date de quand ?
Générez-la à chaque build.

Voyez comment HexaGlue documente automatiquement un domaine de 50 classes.

Voir la documentation en action Configurer le plugin

La documentation se périme.Sauf quand elle se compile avec le code.