As a part of my job, I am spending quite amount of time for documentation. Flowcharts, diagrams, class designs and many more. One of the challenges or creating diagrams are they are difficult to revise. My normal flow is to create a diagram in a tool (i.e draw.io) and then export it as .svg or .pdf format. Afterwards, use this exported file in the documentation.
Downside of this approach is, I cannot see the older versions or what kind of changes I am making during the new version of documentation.
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
I was looking for a tool to solve this issue when I found out Mermaid. In their site, they define themselves as a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
I gave it some try and must say they do a good job. However for complex flowcharts things are easily getting out of hand with links going all over the place.
I will give it more try to find out whether I can make the best out of it.