diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md index 3b9181164..3a74e4cb1 100644 --- a/docs/n00b-overview.md +++ b/docs/n00b-overview.md @@ -2,26 +2,27 @@ ## Explaining with a Diagram -A picture is worth a thousand words, a good diagram is certainly worth more. Yet very few people use them, even fewer still do so for documentation. Maybe, because it takes too much time. - +A picture is worth a thousand words, a good diagram is certainly worth more. ## Creating and Maintaining Diagrams Anyone who has used Visio, or (God Forbid) Excel to make a Gantt Chart, knows how hard it is to make, edit and maintain good visualizations. -In an environment of constantly changing information , diagrams/charts are both very important and also become obsolete/inaccurate very fast. This catch-22 hobbles the information transfer and productivity in teams. + Diagrams/Charts are both very important but also become obsolete/inaccurate very fast. This catch-22 hobbles the productivity of teams. # Doc Rot in Diagrams -Doc-Rot is quite quick on diagrams makes, after a change is made, it quite hard to rationalize taking hours in a desktop application, to produce a diagram that you would need to recreate again the following week in order to account for updates and changes in the app you are documenting. Yet that is often the reality for diagrams and charts and the people who make them. +Doc-Rot kills diagrams as quickly as it does text, but it takes hours in a desktop application to produce a diagram. -mermaid seeks to change that. mermaid is a javascript based tool that utilizes a markdown inspired syntax to generate documentation, which is actually quicker, less complicated and more convenient than most traditional diagramming software. This is a relatively straightforward solution to a major hurdle in software teams. +mermaid seeks to change that. mermaid creates diagrams using markdown inspired syntax. The process is quicker, less complicated and more convenient way of going from concept to visualization + +This is a relatively straightforward solution to a major hurdle in software teams. # Definition of Terms/ Dictionary **Mermaid definitions** ->These are the instructions for how the diagram is to rendered, written in mermaid, which is based on Markdown. These can be found inside `