Contexte

La documentation et gestion de livrables est bien souvent un processus fastidieux, néanmoins nécessaire pour de nombreux projets et clients. Une documentation adaptée au contexte permet de garantir ou à minima contribuer à la compréhension, qualité et pérennisation d'une application logicielle testée, livrée et déployée.

La génération documentaire à partir des modèles maintenus dans un référentiel Enterprise Architect simplifie ce processus :

• La mise à jour des informations est réalisée dans un référentiel de modèles, assurant une cohérence globale.
  • La modification d'éléments du modèle est automatiquement répercutée à travers les descriptions et diagrammes. Exemples : le nouveau nom d'une classe est automatiquement visible sur l'ensemble des diagrammes qui l'utilisent, la modification d'une méthode d'interface est visible sur les diagrammes de séquences UML, le nouveau titre d'une exigence est visible sur les cas d'utilisations qui la réalisent, etc. 
• Le générateur eaDocX s'appuie sur un modèle documentaire qui comprend les sections dans lesquelles le contenu et les diagrammes doivent être mis à jour/générés. Cela évite de nombreux copier/coller de diagrammes UML, BPMN, SysML, ArchiMate ou autre dans un document Word externe.
• Cette approche donne lieu à une gestion dynamique des livrables documentaires : elle remplace la mise à jour manuelle d'un document Word après un atelier ou une réunion où l'auteur essaie de répercuter au mieux les modifications demandées (nécessitant souvent la mise à jour de diagrammes Visio ou autres pour être ensuite copiés/collés dans Word). Avec Sparx EA et eaDocX, les modèles peuvent être mis à jour en direct avec les participants (sous EA ou Excel), ou après la séance. Le résultat obtenu dans le document généré correspond alors exactement à ce qui a été exprimé par l'équipe.

Problématique

Malgré les fonctionnalités fournies par les divers générateurs documentaires EA que j'ai eu l'occasion d'utiliser, la gestion de la mise en page des diagrammes a bien souvent été problématique. En effet les diagrammes générés dans le document doivent souvent être redimensionnés, entraînant ainsi de nombreuses actions manuelles, consommatrices de temps.

Une évolution présente dans la dernière version 3.7 d'eaDocX propose une solution à ce problème ; un nouveau paramétrage permet de définir un hauteur maximum pour les diagrammes en mode portrait ou paysage.

Exemple

Voici l'exemple d'une page initialement générée avec eaDocX : le diagramme ne rentre pas complètement dans la page.

Remarque : une option eaDocX permet d'appliquer automatiquement le mode Paysage sur une page qui contient un diagramme avec des dimensions trop importantes.

Les paramètres eaDocX 3.7 me permettent de désactiver le mode paysage et de saisir une hauteur maximum pour les diagrammes, personnalisée selon le template Word utilisé:

Voici le résultat après avoir généré à nouveau le document : l'auteur n'a plus besoin de redimensionner le diagramme.