Entretenir

Cette leçon est encore en test : elle s'améliore avec les retours des apprenants. Si quelque chose n'est pas clair, c'est la leçon qu'il faut corriger, pas toi.

À la fin de cette leçon, tu sauras

écrire un README qui permet de reprendre ton outil ;
tester ce README avec une séance neuve ;
tenir une routine d’entretien de dix minutes par mois ;
savoir quand archiver un outil.

Pourquoi ça t’intéresse

Un outil qu’on ne comprend plus est un outil qu’on n’ose plus toucher. Dans six mois, tu auras oublié où sont les données, comment les sauvegarder, ce qui a été décidé. Le README garde tout ça, en une page. Et une petite routine mensuelle évite les mauvaises surprises : la sauvegarde qui ne marche plus, la donnée perdue, la modification qui a tout cassé.

Avant de commencer


Il te faut	Claude Code (appli ou terminal), en mode Manuel, ton outil avec sa spécification et son historique Git, et le modèle de README (ressource)
Coût	L’abonnement de l’agent : Claude Pro au minimum, 18 € par mois hors taxes en facturation mensuelle, ou 15 € par mois hors taxes avec l’abonnement annuel de 180 € payé d’avance ; prix affichés sur claude.com/pricing au 24/10/2026
Durée	45 minutes, puis 10 minutes par mois
Rappel	Les sauvegardes de ton outil contiennent ses données : range-les comme le reste de tes copies

Comprendre en 3 minutes

Ce qui fait durer un petit outil :

Pièce	Ce qu’elle garde
La spécification (leçon 1)	Ce que l’outil doit faire, et comment le vérifier
L’historique Git (leçon 5)	Chaque version, avec ce qui a changé
Le README (cette leçon)	Comment s’en servir, où sont les données, comment le modifier
Les sauvegardes (leçon 3)	Les données, hors du navigateur

Peu de pièces, peu d’entretien. La CNIL conseille d’évaluer l’intérêt de chaque dépendance : certaines ne font que quelques lignes, et chaque élément ajouté augmente la surface d’attaque. Un outil en un seul fichier, sans bibliothèque, n’a presque rien à mettre à jour.

La CNIL rappelle aussi que la documentation est cruciale pour la maintenance d’un projet : c’est le rôle du README.

Toute modification suit le même circuit : la spécification d’abord (si le besoin change), une version Git, la modification, tous les essais, une nouvelle version.

Faire ensemble

1Étape 1 : Écrire le README

Dans Claude Code, sur ton dossier de projet, en mode Manuel, utilise la demande de la ressource Modèle de README.

Lors de notre essai du 24/10/2026, pour le carnet d’emprunts du club, le README a tenu en 25 lignes : les fichiers, comment ouvrir l’outil, où sont les données (et ce qui les efface), sauvegarder et restaurer, et comment demander une modification avec une version Git avant et après.

2Étape 2 : Le tester

Copie le README seul dans un dossier vide, et ouvre une séance neuve dessus :

Lis seulement README.md. En 3 lignes : où sont gardées les données, comment je les sauvegarde, et que se passe-t-il si j'ouvre l'outil dans un autre navigateur ?

Lors de notre essai, la séance neuve a répondu juste sur les trois points, en ne lisant que le README. Si la réponse est fausse ou incomplète chez toi, corrige le README, pas la réponse.

3Étape 3 : La routine du mois

Une fois par mois, dix minutes :

exporte une sauvegarde des données, et range-la avec tes copies ;
vérifie qu’elle se réimporte (dans un autre navigateur, par exemple) ;
refais deux ou trois essais de la spécification ;
regarde git status : tout est-il enregistré ?
note la date dans la partie « Dernier entretien » du README.

4Étape 4 : Archiver ce qui ne sert plus

Un outil qui ne sert plus : une dernière sauvegarde de ses données, une dernière version Git, puis range le dossier dans tes archives et note-le dans ton journal. Tu pourras le reprendre grâce au README.

Faire toi-même

Le livrable du module 12 : ton outil local, avec :

sa spécification, à jour (leçon 1) ;
l’outil, dont chaque critère a été vérifié (leçons 3 et 4) ;
son historique Git, avec des messages clairs, et un .gitignore (leçon 5) ;
aucun secret ni donnée personnelle inutile (leçon 6) ;
ta décision de mise en ligne, écrite (leçon 7) ;
un README testé par une séance neuve, et la date du premier entretien.

Ressources à télécharger

Modèle de README pour ton outil : les parties, la demande à ton agent, et le test par une séance neuve.

Vérifier

C’est réussi si :

ton README tient en une page, et une séance neuve qui ne lit que lui répond juste ;
la routine du mois est notée dans ton agenda ou ton journal ;
la partie « Dernier entretien » du README est datée ;
tu sais comment archiver ton outil le jour où il ne sert plus.

Erreurs fréquentes :

un README écrit une fois, jamais mis à jour ;
des sauvegardes jamais réimportées : on découvre trop tard qu’elles ne marchent pas ;
ajouter des bibliothèques « pour faire mieux », et devoir les entretenir ;
modifier l’outil sans passer par la spécification et une version Git.

Conserver et reprendre

Ajoute la routine du mois à ton entretien mensuel (module 5, leçon 7).
Garde ensemble : la spécification, l’outil, le README, et le dossier de sauvegardes.

Pour aller plus loin

facultatif

Le module 13 propose un projet final : ton outil peut en être le point de départ.

Mots nouveaux

4 mots expliqués

Mot	Ce que ça veut dire
README	La notice d’un outil, rangée dans son dossier
Entretien	Les vérifications régulières qui gardent un outil utile et fiable
Dépendance	Un élément extérieur dont l’outil a besoin pour marcher (une bibliothèque, un service)
Archiver	Ranger un outil qui ne sert plus, avec de quoi le reprendre