Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b37ae52

Browse files
Shubham GargShubham Garg
Shubham Garg
authored and
Shubham Garg
committedAug 25, 2024
updates for aug 2024
1 parent aadc1d5 commit b37ae52

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed
 

‎README.md

+24-18
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ A curated list of awesome diagramming tools available for software engineering t
44

55

66
### **When diagrams are useful?**
7-
Diagrams are faster and compact way for knowledge transfer. It's much easier to convey system architechture with a diagram compared to writing an essay on it.
87

9-
Diagrams are especially useful in providing high level overview of software design. Following are the most-widely used diagrams by engineering teams:
10-
- **Sequence diagram** - to visualize interaction between different components in a sequential order
11-
- **System architecture diagram** - to visualize system architecture
12-
- **ER diagram** - to visualize data models
13-
- **Gantt diagram** - used for project planning and timeline estimation
8+
Diagrams are faster and compact way for knowledge transfer. It's much easier to communicate a system architecture with a diagram compared to writing an essay on it.
9+
10+
Following are the major categories diagrams used by most efficient software engineering teams (based on more than 30 interviews with engineers working in startups and big tech):
11+
- **System Architecture Diagram** - to visualize high-level structure of a software system and interactions between difference components
12+
- **Sequence Diagram** - to visualize data flow between different components in a sequential order
13+
- **Database Schema Diagram** - to visualize data models and relations between entities (ER Diagrams)
14+
- **Gantt Chart** - used for project planning and timeline estimation
1415

1516

1617
### **Factors to consider before choosing the diagramming tool**
@@ -27,16 +28,19 @@ Examples - [Link](https://kroki.io/examples.html)
2728
* [Mermaid](https://mermaid-js.github.io/mermaid/) (Free, Open Source, Diagram as code, Ease of use - Easy, Visual Appearance - Modern).
2829
Examples - [Link](https://mermaid-js.github.io/mermaid/#/examples)
2930

31+
* [Eraser.io](https://www.eraser.io/) (Freemium, Closed Source, Hand drawn, Ease of use - Easy, Visual Appearance - Modern).
32+
Examples - [Link](https://www.eraser.io/examples)
33+
3034
* [Excalidraw](https://excalidraw.com/) (Freemium, Open Source, Hand drawn, Ease of use - Easy, Visual Appearance - Hand-drawn).
3135
Examples - [Link]()
3236

33-
* [PlantUML](https://plantuml.com/) (Free, Open Source, Diagram as code, Ease of use - Intermediete, Visual Appearance - Outdated)
37+
* [PlantUML](https://plantuml.com/) (Free, Open Source, Diagram as code, Ease of use - Intermediate, Visual Appearance - Outdated)
3438
Examples - [Link](https://plantuml.com/), [Link](https://real-world-plantuml.com/)
3539

3640
* [Draw.io](http://draw.io/) (Free, Open Source (But Closed To Contribution), Hand drawn, Ease of use - Moderate, Visual Appearance - Modern).
3741
Examples - [Link](https://www.diagrams.net/example-diagrams)
3842

39-
* [Nomnoml](https://www.nomnoml.com/) (Free, Open Source, Diagram as code. Ease of use - Easy, Visual Apperance - Minimalistic).
43+
* [Nomnoml](https://www.nomnoml.com/) (Free, Open Source, Diagram as code. Ease of use - Easy, Visual Appearance - Minimalistic).
4044
Examples - [Link](https://www.nomnoml.com/)
4145

4246
* [Diagram.codes](https://playground.diagram.codes/) (Freemium, Closed Source, Diagram as code, Ease of use - Easy, Visual Appearance - Outdated).
@@ -46,18 +50,12 @@ Examples - [Link](https://playground.diagram.codes/)
4650
Examples - [Link](https://www.lucidchart.com/pages/tour)
4751

4852
* [Blockdiag](http://blockdiag.com/) (Free, Open Source, Diagram as code, Ease of use - Easy, Visual Appearance - Outdated).
49-
Exampes - [Link](http://blockdiag.com/en/blockdiag/examples.html)
53+
Examples - [Link](http://blockdiag.com/en/blockdiag/examples.html)
5054

5155
Others - [Miro](https://miro.com/), [Gliffy](https://www.gliffy.com/), [Inkscape](https://inkscape.org/), [Plectica](https://www.plectica.com/), [Whimsical](https://whimsical.com/), [ZenUML](https://zenuml.com/), [Gleek](https://www.gleek.io/), [Structurizr](https://structurizr.com/dsl), [StarUML](https://staruml.io/)
5256

5357

54-
### **Sequence diagram**
55-
- [Swimlanes](https://swimlanes.io/) (Free, Closed Source, Ease of use - Easy, Visual Appearance - Modern)
56-
Examples - [Link](https://diagrams.mingrammer.com/docs/getting-started/examples)
57-
58-
Others - [Websequencediagrams](https://www.websequencediagrams.com/), [Sequencediagram.org](https://sequencediagram.org/)
59-
60-
### **System design diagram**
58+
### **System Architecture Diagram**
6159
> **Essential readings**
6260
[C4 Model](https://c4model.com/), [5 types of architecture diagrams](https://www.readysetcloud.io/blog/allen.helton/the-5-types-of-architecture-diagrams/)
6361
- [Diagrams](https://diagrams.mingrammer.com/) (Free, Open Source, Ease of use - Easy, Visual Appearance - Modern).
@@ -69,12 +67,20 @@ Examples - [Link](https://terrastruct.com/examples/1/)
6967
- [IcePanel](https://icepanel.io/) (Paid, Closed Source, Hand drawn, Ease of use - Easy, Visual Appearance - Modern)
7068
Examples - [Link](https://s.icepanel.io/vmHvBHr4BeMEOa/iyAG)
7169

72-
- [Lucidscale](https://lucidscale.com/) (Paid, Closed Source, Ease of use - Intermediete, Visual Appearance - Modern).
70+
- [Lucidscale](https://lucidscale.com/) (Paid, Closed Source, Ease of use - Intermediate, Visual Appearance - Modern).
7371
Examples - [Link](https://lucidscale.com/tutorial)
7472

7573
Others - [Ilograph](https://www.ilograph.com/), [Omnigraffle](https://sequencediagram.org/), [Cloudcraft](https://www.cloudcraft.co/), [CloudSkew](https://www.cloudskew.com/)
7674

77-
### **ER diagram**
75+
76+
### **Sequence Diagram**
77+
- [Swimlanes](https://swimlanes.io/) (Free, Closed Source, Ease of use - Easy, Visual Appearance - Modern)
78+
Examples - [Link](https://diagrams.mingrammer.com/docs/getting-started/examples)
79+
80+
Others - [Websequencediagrams](https://www.websequencediagrams.com/), [Sequencediagram.org](https://sequencediagram.org/)
81+
82+
83+
### **Database Schema Diagram**
7884

7985
> **Essential Readings**
8086
[How to choose your ERD?](https://azimutt.app/blog/how-to-choose-your-entity-relationship-diagram)

0 commit comments

Comments
 (0)
Please sign in to comment.