Aller au contenu
Formation gratuite et accessible à tous. Les cours évoluent grâce à tes retours.
Langue : FR

Modèle de README pour ton outil

Le fichier s'ouvre avec n'importe quel éditeur de texte (Bloc-notes, TextEdit) ou se colle dans tes notes.

Modèle de README pour ton outil

Le README est la notice de ton outil, rangée dans son dossier. Il sert à toi dans six mois, et à toute personne (ou toute IA) qui reprend l’outil (leçon 8). Une page au plus.

# [Nom de l'outil]

## À quoi il sert
[Une ou deux phrases.]

## Les fichiers
- [fichier] : [à quoi il sert]
- [fichier] : [à quoi il sert]

## L'ouvrir
[Comment, sur quel appareil, avec quel navigateur.]

## Où sont les données
[Où elles sont gardées, ce qui peut les effacer.]

## Sauvegarder et restaurer
[Les boutons, où ranger le fichier, comment le recharger.]

## Modifier sans risque
1. Une version Git avant (« avant : … »).
2. La modification, puis tous les essais de la spécification.
3. Une version Git après, ou un retour en arrière.

## Dernier entretien
[Date] : [ce qui a été vérifié]

La demande à ton agent

Écris README.md pour ce dossier, en 25 lignes au maximum, pour une personne qui ne code pas, avec exactement ces parties : [colle les parties du modèle].
Seulement ce qui est vrai dans les fichiers du dossier. Ne crée aucun autre fichier.

Le test du README

Dans une séance neuve, qui ne lit que le README :

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 ?

Si la réponse est fausse ou incomplète, c’est le README qu’il faut corriger.