Compétence

Documenter ses projets : README et démos

Créer une documentation utile qui facilite l’évaluation et la reprise de vos projets.

21 août 2026•3 min de lecture

Documenter ses projets : README et démos

Objectif

Permettre à un recruteur ou collègue de comprendre et lancer votre projet en 10 minutes.

Contenu essentiel

Résumé du projet
Stack technique
Installation & lancement
Exemples d’utilisation
Liens : code, démo, contact

Astuce

Ajoutez badges CI et couverture si disponibles

Tags

#documentation#portfolio#readme

Niveau

beginner

Comment apprendre

Rédigez un README pour chaque projet
Ajoutez une démo hébergée
Incluez instructions d’installation