Écrivez la documentation technique de votre projet

Pour créer une application de qualité, vous devez rendre votre code lisible, compréhensible et maintenable par tous les développeurs qui pourront intervenir sur le projet. Pour cela, il vous faut communiquer clairement comment fonctionne votre code et comment est structurée l'architecture de l'application.

Dans ce cours, nous allons voir ensemble les bonnes pratiques pour rendre votre code autodocumenté, puis comment créer une bonne documentation et la publier en ligne, et également comment documenter une API.

Dans la deuxième partie, nous verrons quelques bonnes pratiques pour créer une documentation d'architecture, et les bonnes questions à vous poser.

Votre professeur pour ce cours : Francis Bock

Francis est Directeur Adjoint d'un projet européen qui produit des services géospatiaux. Il a enseigné le développement backend à l'Université Gustave Eiffel et il a été DSI dans l'administration.

Vous voulez donner à vos collaborateurs la meilleure expérience possible lors de l'utilisation de votre code et sa documentation ? Alors rendez-vous au premier chapitre !