Mermaid - Diagrams as a Code - devszczepaniak.pl

Parafrazując znany slogan reklamowy - _"jeden obrazek może wyrazić więcej niż tysiąc słów"_. Dobrze zaprojektowany diagram często stanowi lepsze przedstawienie kodu lub architektury niż obszerny opis, interfejs czy komentarze w kodzie.

Jednym z powodów, dla których porzucałem tworzenie i rozwój diagramów w dokumentacji projektów była ich częsta dezaktualizacja i konieczność wdrażania zmian. W przypadku plików graficznych było to uciążliwe i nieefektywne.

Mermaid rozwiązuje ten problem. Dzięki Mermaid możliwe jest wdrożenie w dokumentacji Diagram as a Code i przechowywać diagramy w formie łatwo rozwijalnego i utrzymywalnego kawałka kodu.

W artykule przedstawiam kilka argumentów za tym, dlaczego warto korzystać z diagramów, jakie są główne problemy z pracą z diagramami, jak przygotować swój pierwszy diagram z Mermaid i jakie możliwości oferuje to rozwiązanie. Dowiesz się także jak zintegrować je z Docsify — jednym z popularnych rozwiązań do rozwijania dokumentacji.

Komentarze (5)

pan-brucciKompan2 lata temu0

radze przejrzec źródła strony

elszczepanoZawodowiec2 lata temu0

@pan-brucci Avast to samo zgłaszał. Prawdopodobnie formularz z mailchimpa im przeszkadza. Zgłosiłem false positive i sprawdzę czy idzie coś zrobić, by się odczepili 🙂

koszotoroburFanatyk2 lata temu3

@elszczepano - dobrze zaprojektowany diagram nigdy nie kończy jako dobrze narysowany diagram - takie są rzadkie jak włochate jednorożce.

koszotoroburFanatyk2 lata temu2

@NiebieskiSzpadelNihilizmu - widzę kolega oblatany :face_with_hand_over_mouth:

NiebieskiSzpadelNihilizmuGURU2 lata temu2

@koszotorobur "dobrze zaprojektowany diagram" kończy zwykle jako jakiś excel zajebany danymi na kilkanaście arkuszy i z masą powiązań, albo kolejny _magiczny_ pptx na prezentacji managerskiej, który pokazuje rosnące słupki bez żadnej skali ani odniesienia, ale raporty dla góry muszą się zgadzać więc jest. Been there, done that.