diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md index a1ef64fe3..84a7223af 100644 --- a/docs/n00b-overview.md +++ b/docs/n00b-overview.md @@ -11,16 +11,16 @@ B --> C[Server01] B --> D[Server02] ``` -And end up getting this in the documentation on a web page: +And end up getting this in the documentation: ![Flowchart](./img/n00b-firstFlow.png) -Most of the stuff I need to visualize can be done, using a varitety of different symbols and chart types. +Most of the stuff I need to visualize can be scripted like this, with a varitety of different symbols and chart types. -Compared to Visio and other similar applications, mermaid is a really easy way to create visualizations when writing documentation. +Comparing with Visio and similar applications, mermaid is a really fast and simple way to create good visualizations when writing documentation. This is especially apparent when a complex visualisation needs to be edited, which could take hours in a desktop application. With mermaid I can spend a fraction of that time automating the diagram generation and end up saving even more time. I love it! -Since the diagram source can be part of scripts (and other pieces of code), less time needs be spent documenting as a separate task. +Since the diagram source can be part of production scripts (and other pieces of code), less time needs be spent on documenting as a separate task. -However, a lot of the mermaid documentation is geared to professional developers and presumes a skill set which I don't have. +However, a lot of the mermaid documentation is geared to professional developers and presumes a skill set which I do not have. -I need a really simple and basic instruction. +I needed a really simple and basic instruction, and here it is.