Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 886 Bytes

00-intro.md

File metadata and controls

28 lines (19 loc) · 886 Bytes

Introduction

Diagrams are useful conveying ideas and thoughts. It is useful for communication and even understanding the system architecture.

The book covers two main diagramming techniques: UML and C4 model.

UML deals with three types of diagrams:

  1. structure
  2. behavior
  3. interaction

Why Mermaid?

PlantUML is not as widely adopted as Mermaid. GitHub and GitLab both have native support for Mermaid.

There are many ways to create diagrams using Mermaid, from the terminal to web-based editors:

Markdown Preview Mermaid Support is a popular VS Code extension.

Example

flowchart LR
  a --> b & c --> d
Loading