Mermaid.js

Mermaid est un outil open source innovant pour créer des diagrammes à partir d'une syntaxe textuelle inspirée du Markdown. Lancé en 2014, il vise à simplifier la création et la modification de diagrammes, tout en facilitant leur partage. Au fil du temps, Mermaid a étendu ses capacités pour inclure divers types de diagrammes, tels que les flowcharts, les diagrammes de séquence et les schémas entité-relation, répondant ainsi à un large éventail de besoins en documentation.

L'intégration native de Mermaid dans des plateformes majeures comme GitHub, GitLab et Notion, ainsi que sa disponibilité via des extensions pour Confluence, Google Docs et VSCode, témoigne de sa pertinence croissante. Cette intégration permet d'élever la création de visuels au même niveau que la documentation textuelle, favorisant une communication plus claire et efficace. La syntaxe intuitive de Mermaid (par exemple, A --> B) permet aux débutants de créer rapidement leurs premiers schémas. L'outil se charge automatiquement de l'optimisation du layout, permettant aux utilisateurs de se concentrer sur le contenu plutôt que sur la mise en forme.

Mermaid offre une certaine flexibilité dans la représentation des éléments, comme l'utilisation de formes spécifiques pour les bases de données ou de liens en pointillés. La stylisation se limite principalement à une coloration via CSS, bien qu'elle reste basique et difficile à maîtriser. Cependant, des personnalisations plus avancées telles que l'ajout d'images, l'ajustement de la taille du canevas ou l'inclusion d'éléments dynamiques restent hors de portée.

Le point de vue Theodo

Nous recommandons l'adoption de Mermaid dans les organisations utilisant des outils qui le supportent nativement. Son utilisation devrait être encouragée auprès des collaborateurs pour compléter efficacement leur documentation habituelle. Cependant, pour des diagrammes destinés à une audience externe, ou nécessitant une personnalisation poussée ou une complexité particulière, d'autres outils comme draw.io, Excalidraw ou Whimsical seraient plus appropriés.