Diagrams and Central Documentation
Learn about the types of diagrams and the concept of centralized documentation.
We'll cover the following...
Overview
In this lesson, we'll study the types of diagrams used in documentation. We'll use Graphviz and Mermaid diagrams as examples. This lesson will also cover the purpose of concise documentation and how to make a brief yet useful README file.
Types of diagrams
Adding pictures to documentation makes it quicker to understand what's going on. It’s better if this is done with a tool that can be compiled from a source which can then be kept in source control. Let’s discuss a few types of diagrams that we can use.
Graphviz
Graphviz is a great way to document software ...