Préliminaires

Pour pouvoir générer de la documentation avec Modelio, vous devez d’abord installer le module Document Publisher dans votre projet, en exécutant la commande "Configuration / Installer un module" puis en sélectionnant le module "Document Publisher".

Avant de générer de la documentation, il faut disposer d’un modèle structuré dans lequel vous avez déterminé les points d’entrée contenant les éléments qui doivent figurer dans la documentation.

Différents types de notes décrivant les divers aspects de l’élément sont proposés pour chaque élément. Une fois votre modèle annoté par ces notes, vous pouvez lancer la génération de la documentation.

Racines de génération de documentation

La génération de documentation débute toujours à partir d’un ou plusieurs éléments dans le modèle, afin de générer tous les éléments qu’il(s) structure(nt). La plupart du temps, cet élément est un package, mais il peut tout aussi bien être une classe, un acteur, un cas d’utilisation ou tout autre type d’élément, suivant le plan-type utilisé.