Tous les cours

Développement

Écrivez la documentation technique de votre projet

Documentez votre projet de manière claire et maintenable avec les conventions de nommage, README, ou encore les outils de documentation d'API, ainsi qu'un document d'architecture technique.
DifficultéMoyenne6 heures
Ce cours en libre accès vous intéresse ?

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 !

Objectifs pédagogiques

  • Documenter son code pour le rendre maintenable et réutilisable
  • Créer de la documentation pour une architecture

Prérequis

Prérequis

  • Pour suivre certains chapitres de ce cours, vous devrez savoir utiliser les fonctions de base de Git. Si ce n'est pas le cas, suivez le cours Gérez du code avec Git et GitHub.

Et si vous en faisiez votre métier ?

Suivez une des formations diplômantes de notre école 100% en ligne, et transformez vos connaissances en compétences professionnelles.

  • Formations jusqu’à 100 % financées
  • Date de début flexible
  • Projets professionnalisants
  • Mentorat individuel

Contributeurs

Professeur

Francis B

Directeur d'un centre de services de la fonction publique et mentor dans le domaine IT

Créé par

Mis à jour le 23/01/2025

Licence

Développement

Écrivez la documentation technique de votre projet

DifficultéMoyenne6 heures
Cours en libre accès