Einführung in Polyglot Notebook
Das Dokumentieren eines Systems ist der Schlüssel, um effizient damit arbeiten zu können. Es gibt jedoch verschiedene Arten der Dokumentation, von spezifischen API-Dokumenten über schriftliche Dokumentationen, die das System beschreiben, bis hin zur Unified Modeling Language (UML), und sogar Tests können als Teil der Dokumentation betrachtet werden. Systeme ändern sich, also muss sich auch die Dokumentation mit ihnen ändern. Eine gute Dokumentation sollte auch Code enthalten, der zeigt, wie Sie mit verschiedenen Teilen des Systems arbeiten.
Szenario: Erstellen einer dynamischen Dokumentation für mein Entwicklungsteam
Als Teil eines Entwicklungsteams erstellen und verwalten Sie viele verschiedene Codebasen von Back-End bis Front-End und sogar ein mobiles App-Projekt. Sie wechseln häufig zwischen Projekten, um Fehler zu beheben oder ein neues Feature zu erstellen. Um sowohl das Onboarding als auch den „Kontextwechsel“ zu vereinfachen, möchten Sie eine Möglichkeit finden, Ihre Systeme zu dokumentieren, damit sie einfacher verwaltet werden können.
Nach Abschluss dieses Moduls werden Sie zu Folgendem in der Lage sein:
- Erläutern, warum Sie Polyglot Notebooks verwenden sollten.
- Erstellen und Ausführen von Notebooks.
- Nutzen der Funktionen wie die Freigabe von Variablen und Befehlen, um Front-End und Back-End zu kombinieren, sowie Mermaid, um Flussdiagramme und Diagramme zu erstellen.
Lernziele
Durch Den Abschluss dieses Moduls lernen Sie, Ihre IT-Systeme nicht nur mit statischem Text, sondern auch mit Code zu dokumentieren, den Sie ausführen können, um eine lebendige Dokumentation zu erstellen.
Voraussetzungen
Um mit Polyglot Notebooks zu beginnen, müssen Sie:
- Das aktuelle .NET SDK installieren,
- Polyglot Notebooks als Erweiterung in Visual Studio Code installieren. Damit können Sie Notebooks erstellen und ausführen und vieles mehr tun.