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.
#programowanie #informatyka #programista15k #javascript #frontend #naukaprogramowania
