Wprowadzenie do notesu polyglot
Dokumentowanie systemu jest kluczem do wydajnej pracy z nim. Istnieją jednak różne sposoby dokumentowania, od określonych dokumentacji interfejsu API, pisemnej dokumentacji opisującej system, ujednolicony język modelowania (UML), a nawet testy można uznać za część dokumentacji. Systemy się zmieniają, więc dokumentacja musi się z nimi zmieniać. Dobra dokumentacja powinna również zawierać kod, który pokazuje, jak pracować z różnymi częściami systemu.
Scenariusz: Tworzenie żywej dokumentacji dla mojego zespołu deweloperów
W ramach zespołu deweloperów tworzysz i utrzymujesz wiele różnych baz kodu— od zaplecza po fronton, a nawet projekt aplikacji mobilnej. Często przełączasz się między projektami, aby rozwiązać problem z usterką lub utworzyć nową funkcję. Aby ułatwić zarówno dołączanie, jak i przełączanie kontekstu, chcesz znaleźć sposób dokumentowania systemów, aby ułatwić ich konserwację.
Po ukończeniu tego modułu będziesz mieć następujące umiejętności:
- Wyjaśnij, dlaczego należy używać Notesy Wielojęzyczne.
- Tworzenie i uruchamianie notesów.
- Funkcje takie jak udostępnianie zmiennych i polecenia umożliwiają łączenie frontonu i zaplecza oraz syreny w celu renderowania schematów blokowych i diagramów.
Cele szkolenia
Po ukończeniu tego modułu dowiesz się, jak dokumentować systemy IT nie tylko przy użyciu tekstu statycznego, ale także kodu, który można uruchomić, aby utworzyć żywą dokumentację.
Wymagania wstępne
Aby rozpocząć pracę z Notesy Wielojęzyczne, musisz:
- Zainstaluj najnowszy zestaw .NET SDK,
- Zainstaluj Notesy Wielojęzyczne jako rozszerzenie w programie Visual Studio Code. Z tego miejsca możesz tworzyć i uruchamiać notesy i wykonywać wiele innych czynności.