Wpisy z tagiem: dokumentacja
Tagi popularne na mikroblogu
- programowanie × 848
- off-topic × 555
- autopromocja × 382
- links × 233
- 4programmers.net × 233
- koziolekweb × 230
- blog × 188
- coyote × 173
- praca × 171
- lazarus × 149
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.
Mermaid - Diagrams as a Code - devszczepaniak.pl
Problemem z diagramami w dokumentacji jest ich dezaktualizacja. Mermaid rozwiązuje ten problem i pozwala tworzyć diagramy za pomocą kodu!
https://devszczepaniak.pl/mermaid-diagrams-as-a-code/
Oracle Dataedo. Ciekawa aplikacja do dokumentowania baz danych. Wspiera bazy Sql Server i Oracle.Całkowicie darmowa, choć ma powstać wersja płatna z dodatkowymi funkcjami. Ułatwia dokumentowanie baz danych poprzez automatyczne generowanie szablonu bazującego na istniejącej strukturze bazy danych. Pozwala na uzupełnianie opisu każdego obiektu z bazy. Nie pobiera danych, a jedynie struktury. Powstaje łatwa w utrzymaniu, przejrzysta i estetyczna dokumentacja.
#baza #oracle #sqlserver #dokumentacja #bazadanych