From 9e59d927f277db707b4814ce10bf8ae0bd968466 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Mon, 20 Jul 2020 11:51:23 -0700 Subject: [PATCH] Update n00b-overview.md --- docs/n00b-overview.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md index c47d6032f..96e4e7b99 100644 --- a/docs/n00b-overview.md +++ b/docs/n00b-overview.md @@ -13,15 +13,15 @@ Anyone who has used Visio, or (God Forbid) Excel to make a Gantt Chart, knows ho In an environment of constantly changing information , diagrams/charts become obsolete/inaccurate very fast. This hobbles the information transfer and productivity in teams. -# Doc Rot and Dagrams +# Doc Rot kills Diagrams -The fast setting Doc-Rot in diagrams makes 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. +The fast setting Doc-Rot in diagrams makes 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. -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 traditional diagramming software. This is a relatively straightforward solution to a major hurdle in software teams, +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. -# The primary objective of mermaid is to help in addressing the problem of Documentation Rot. +# The primary objective of mermaid is to help in addressing the problem of Doc Rot. -with mermaid, diagrams can be created through comments like this in a script: +With mermaid, diagrams can be created through comments like this in a script: ``` graph TD