Comment écrire une bonne requête de code ?
Une bonne requête à un assistant de code dit où l’on travaille et ce que l’on veut. Elle dit aussi ce qui est interdit et à quoi doit ressembler la réponse. Plus elle est précise, moins l’assistant devine, et moins il invente.
Dites « fais le panier » à un camarade qui ne connaît pas votre projet : il hésitera. L’assistant, lui, répondra quand même, et souvent à côté.
À la fin de cette leçon
Remarque
Je peux écrire une requête avec son contexte, ses contraintes, un exemple et le format attendu.
Mots-clés
| Mot | Ce que ça veut dire | Exemple |
|---|---|---|
| Requête | le texte que vous envoyez à l’assistant | |
| Contexte | ce que l’assistant doit savoir sur votre projet | |
| Contrainte | une règle que la réponse doit respecter | ne modifie pas les tests |
| Exemple | un cas avec l’entrée et le résultat attendu | |
| Format | la forme de la réponse : code seul, liste, trois phrases | |
| Affiner | corriger sa requête après avoir lu une première réponse |
Les cellules que les étudiants remplissent restent vides dans cet aperçu.
Une bonne requête a quatre éléments
Le contexte dit dans quel projet et quel fichier vous travaillez. La contrainte dit ce que la réponse ne doit pas faire. L’exemple donne une entrée et le résultat attendu. Le format dit comment présenter la réponse.
Ces quatre éléments s’ajoutent à la tâche elle-même : ce que vous voulez obtenir, dit en une phrase.
Les quatre éléments sur un exemple
| Élément | Question à laquelle il répond | Exemple |
|---|---|---|
| Contexte | Où suis-je ? | La caisse d’une boutique de lycée, fichier caisse.py |
| Contrainte | Qu’est-ce qui est interdit ? | Ne pas modifier les tests |
| Exemple | Quel résultat j’attends ? | Pour une pomme à 35 centimes, le total est 35 |
| Format | Sous quelle forme ? | Le code de la fonction seulement |
Les cellules que les étudiants remplissent restent vides dans cet aperçu.
La même demande, avant et après
| Version | Requête |
|---|---|
| Avant | Fais le panier. |
| Après : contexte | Je travaille sur la caisse d’une boutique de lycée, fichier caisse.py. |
| Après : tâche | Écris la fonction total(panier), qui ajoute les prix en centimes. |
| Après : contrainte | N’ajoute aucune bibliothèque et ne modifie pas les tests. |
| Après : exemple | Pour une pomme et un jus, total doit rendre 120. |
| Après : format | Réponds avec le code de la fonction seulement. |
Les cellules que les étudiants remplissent restent vides dans cet aperçu.
Affinez au lieu de recommencer
La première réponse est rarement la bonne. Lisez-la, puis dites précisément ce qui ne va pas : « le total oublie le dernier article ». Une correction précise vaut mieux qu’un nouveau départ.
Demandez aussi à l’assistant de dire ce dont il n’est pas sûr. Il le fait souvent, et cela vous dit où vérifier.
Envoyer une requête à l’assistant du laboratoire
La commande suivante envoie une requête à l’assistant du laboratoire. Elle donne le contexte, une consigne de forme et une contrainte : ne modifier aucun fichier. Elle suppose que l’assistant est prêt : voyez le fichier d’état de la leçon 1.
La réponse change d’une fois à l’autre. Lisez-la et jugez-la, sans la recopier aveuglément.
Une requête avec contexte et contrainte
docker exec -w /home/node/project agent opencode run "Dans shop.js, explique en trois phrases ce que fait la fonction change. Ne modifie aucun fichier."Affichée ici, non exécutée. Créez un compte gratuit pour appuyer sur Exécuter et la saisir dans le terminal de votre propre labo.
Erreur fréquente
Attention
Beaucoup pensent qu’une requête courte laisse l’assistant libre de bien faire. Elle le laisse surtout libre de deviner. Quand vous ne dites pas ce qui est interdit, il peut modifier des fichiers que vous vouliez garder intacts.
Vérifier ce qui manque à une requête
Dans le devoir, vous écrivez un petit vérificateur de requêtes. Chaque élément se reconnaît à des mots-signaux. Le contexte : projet, fichier, fonction ou programme. La contrainte : sans, ne modifie, seulement ou uniquement.
L’exemple : exemple. Le format : liste, tableau, phrases ou etapes. Un vrai relecteur lit le sens, mais ce tri vous apprend à compter ce qui manque.