Présentation de Notebooks polyglottes
Il est essentiel de documenter un système pour pouvoir l’utiliser efficacement. Il existe cependant différentes façons de documenter : des documents spécifiques aux API, de la documentation écrite décrivant le système, des schémas UML et même des tests peuvent être considérés comme faisant partie de la documentation. Les systèmes évoluent : la documentation doit donc évoluer avec eux. Une bonne documentation doit également inclure du code qui montre comment utiliser différentes parties du système.
Scénario : Création d’une documentation vivante pour mon équipe de développement
Vous faites partie d’une équipe de développement, et vous créez et vous gérez de nombreux codebases différents du back-end au front-end, et même un projet d’application mobile. Vous passez souvent d’un projet à l’autre pour résoudre un bogue ou créer une nouvelle fonctionnalité. Pour faciliter l’intégration et le changement de contexte, vous voulez trouver un moyen de documenter vos systèmes pour qu’il soit plus facile de les maintenir.
À l’issue de ce module, vous pourrez :
- Expliquer pourquoi vous devriez utiliser Notebooks polyglottes.
- Créer et exécuter des notebooks.
- Utiliser des fonctionnalités comme le partage de variables et des commandes pour combiner front-end et back-end avec Mermaid pour afficher des organigrammes et des diagrammes.
Objectifs d’apprentissage
En effectuant ce module, vous découvrez comment documenter vos systèmes informatiques non seulement avec du texte statique, mais aussi avec du code que vous pouvez exécuter pour créer une documentation vivante.
Prérequis
Pour bien démarrer avec Notebooks polyglottes, vous devez :
- Installer le dernier Kit de développement logiciel (SDK) .NET
- Installer Notebooks polyglottes en tant qu’extension sur Visual Studio Code. À partir de là, vous pouvez créer et exécuter des notebooks et en faire beaucoup plus.