From 7ee9c4fb305c4f3194425728f589036be423fa71 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 31 Jul 2020 00:56:32 -0700 Subject: [PATCH] Update n00b-overview.md --- docs/n00b-overview.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md index 96e4e7b99..8dad1f53a 100644 --- a/docs/n00b-overview.md +++ b/docs/n00b-overview.md @@ -36,14 +36,16 @@ And they are rendered into this and made part of the documentation: ## Advantages of Using Mermaid -- The Advantages of mermaid include its ease of generation, modification and rendering. -- The number of integrations that it has. -- It is a package that can be deployed to create +- Ease of generation, modification and rendering. +- The number of integrations and plugins it has. +- It can be added to your or your company's website. -## Diagramming and charting is a gigantic waste of developer time, but not having diagrams ruins productivity. +## The catch-22 of Diagrams and Charts: -mermaid can cut down the amount of time, effort and the learning curve that is associated with creating diagrams and charts, by a wide margin. +**Diagramming and charting is a gigantic waste of developer time, but not having diagrams ruins productivity. ** + +mermaid solves this by cutting the time, effort and tooling that is required to create diagrams and charts. Because, the text base for diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs be spent on documenting, as a separate task.