Diagrams and Central Documentation
Explore various diagram types like Graphviz and Mermaid to visually document software architecture. Understand how to write concise, useful README files that link key project components, making team collaboration and project support more efficient.
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 ...