Codex Bonnes pratiques de prompt
Maîtrisez les techniques de prompt pour aider Codex à comprendre plus précisément votre intention et à accomplir efficacement les tâches.
Structure de base d'un prompt
Un bon prompt comprend les éléments suivants :
Éléments de base
| Éléments | Description | Exemple |
|---|---|---|
| Description de la tâche | Ce que vous voulez faire | "Implémenter la fonctionnalité de connexion utilisateur" |
| Contexte | Informations contextuelles associées | "Utiliser le module d'authentification existant" |
| Contraintes | Limitations et exigences | "Doit être compatible avec les API existantes" |
| Résultat attendu | Sortie spécifique | "Retourner le jeton JWT" |
Invite structurée
Exemple d'invite complet
Implémenter un point de terminaison d'API de connexion utilisateur
# Contexte
- Le projet utilise le framework FastAPI
- Le module auth existant gère la logique d'authentification
- La base de données utilise PostgreSQL
# Contraintes
- Utiliser l'utilitaire JWT existant pour générer le jeton
- Les mots de passe sont vérifiés à l'aide de bcrypt
- Il faut ajouter la journalisation des requêtes
# Résultat attendu
- Chemin : POST /api/auth/login
- Corps de la requête : {"email": "...", "password": "..."}
- Réponse de succès : {"token": "...", "user": {...}}
- Réponse d'échec : {"error": "..."}
Principe de décomposition des tâches
Les tâches complexes doivent être décomposées en petites étapes et réalisées étape par étape.
Principes de décomposition
- Chaque étape a un objectif clair
- Les dépendances entre les étapes sont claires
- Vérifier les résultats après chaque étape
- Possibilité de revenir en arrière en cas de problème
Exemple de décomposition
Décomposition des tâches
"Implémenter un système complet d'authentification des utilisateurs"
# Décomposer en petites tâches
Étapes1:"Concevoir la structure de données du système d'authentification, y compris la table des utilisateurs et la table des jetons"
Étapes2:"Implémenter la fonctionnalité d'inscription des utilisateurs, y compris le chiffrement et la vérification des mots de passe"
Étapes3:"Implémenter la fonctionnalité de connexion des utilisateurs et générer un jeton JWT"
Étapes4:"Implémenter un intergiciel de vérification des jetons"
Étapes5:"Implémenter la fonctionnalité de déconnexion des utilisateurs"
Étapes6:"Écrire des tests pour le système d'authentification"
Étapes7:"Mettre à jour la documentation de l'API"
L'utilisation du mode /plan peut aider Codex à décomposer automatiquement des tâches complexes.
Fournir des informations de contexte
Un contexte suffisant aide Codex à comprendre plus précisément l'état du projet.
Contexte clé
| Type | Description | Quand le fournir |
|---|---|---|
| Stack technique | Versions du framework, du langage, des bibliothèques | Tâches effectuées pour la première fois ou nouveaux modules |
| Structure du projet | Emplacement des modules, conventions de nommage | Implique des modifications multi-fichiers |
| Code existant | Fonctions, classes, modules associés | Nécessite une compatibilité ou une extension |
| Contraintes | Exigences de compatibilité, de performance | Comporte des contraintes particulières |
Façons de fournir le contexte
Fournir le contexte
"Le projet utilise Django 4.2 et la base de données est PostgreSQL 15"
# Référencer le code existant
Reportez-vous à la logique de validation dans src/utils/validator.py
# Spécifier le fichier
Modifier src/api/users.py, en conservant le style cohérent avec les autres API
# AGENTS.md fourni automatiquement
Créer le fichier AGENTS.md, Codex lira automatiquement les directives du projet
Traitement des messages d'erreur
Codex peut rapidement localiser les problèmes à partir des messages d'erreur.
Fournir des informations complètes sur l'erreur
Gestion des erreurs
Une erreur s'est produite lors de l'exécution des tests :
AssertionError : statut attendu 200 mais reçu 500
à test_login.py:45
dans test_successful_login
Traceback complet :
...
Analyser la cause et la corriger
# Assistance pour les captures d'écran
Joignez des captures d'écran de l'erreur, Codex peut les consulter directement
Éléments du message d'erreur
- Types d'erreurs et messages
- Trace de pile complète
- Conditions de déclenchement (quelle opération a été effectuée)
- Résultat attendu vs résultat réel
Entrée d'image
Codex prend en charge l'entrée d'images, ce qui convient pour transmettre des informations visuelles.
Scénarios applicables
| Scénarios | Description |
|---|---|
| Capture d'écran de l'erreur | Captures d'écran montrant l'interface d'erreur ou les journaux |
| Maquette de conception | Convertir des maquettes de design UI en code |
| Diagramme d'architecture | Expliquer le diagramme d'architecture et l'implémenter |
| Graphique de données | Analyser les données |
Méthode d'entrée d'image
Utiliser des images
codex -i screenshot.png
codex --image design.png Implémenter la page en fonction de la maquette de conception
# App/IDE
Coller ou glisser directement des images dans la zone de conversation
# Plusieurs images
codex -i img1.png -i img2.png Comparer les différences entre ces deux maquettes de conception
Optimisation itérative
Optimiser progressivement la qualité du code par itération.
Processus d'itération
- Codex complète l'implémentation initiale
- Vérifier les résultats, proposer des améliorations
- Codex s'ajuste en fonction des retours
- Vérifier l'effet de l'amélioration
- Répéter jusqu'à satisfaction
Optimisation itérative
Implémenter une API de liste d'utilisateurs avec prise en charge de la pagination
# Examiner et proposer des améliorations
Ajouter une fonctionnalité de tri pour prendre en charge le tri par date de création
# Continuer à optimiser
Ajouter une fonctionnalité de recherche pour prendre en charge la recherche par nom d'utilisateur
# Optimisation des performances
Optimiser les performances des requêtes et ajouter des index
Éviter l'ambiguïté
Des prompts clairs réduisent les malentendus et les reprises.
Exemples d'ambiguïté
Éviter l'ambiguïté
Modifier cette fonction
# Prompt clair (bon)
Modifier la fonction format_date dans src/utils/helper.py
# Prompt vague (mauvais)
Le rendre plus rapide
# Prompt clair (bon)
Optimiser la fonction query_users pour réduire le temps de requête de 500ms à moins de 100ms
# Prompt vague (mauvais)
Ajouter une fonctionnalité
# Prompt clair (bon)
Ajouter une fonctionnalité de suppression par lots à l'API utilisateur qui accepte une liste d'ID utilisateur
Utiliser des exemples de référence
Fournir du code ou de la documentation de référence pour aider Codex à comprendre le style attendu.
Fournir une référence
Se référer au style de src/api/products.py pour implémenter l'API utilisateur
# Documentation de référence
Implémenter conformément au document de spécification OpenAPI docs/api-spec.yaml
# Exemple de référence
Retourner la réponse dans ce format :
{
'success': true,
'data': {...},
'message': '...'
}"
Modèles de prompt courants
Modèle de développement de fonctionnalités
Développement de fonctionnalités
Exigences :
- Utiliser [technologie/bibliothèque]
- Être compatible avec [système existant]
- Inclure [gestion des cas limites]
- Retourner [format de réponse]
Référence : [chemin d'une fonctionnalité similaire existante]
Modèle de correction de bug
Correction de bug
Conditions de déclenchement : [circonstances dans lesquelles il se produit]
Message d'erreur :
[Pile d'erreur complète]
Comportement attendu : [ce que le résultat correct devrait être]
Veuillez analyser la cause et la corriger, sans affecter les autres fonctionnalités.
Modèle de revue de code
Revue de code
# Exemple
/review src/auth/ pour problèmes de sécurité
/review HEAD~5..HEAD pour régressions de performance
Résumé des bonnes pratiques
Principes fondamentaux
- Soyez précis et clair, évitez les descriptions vagues
- Fournissez suffisamment de contexte
- Décomposez les tâches complexes pour l'exécution
- Optimisation itérative, amélioration progressive
- Vérifiez les résultats pour garantir l'exactitude
Conseils d'efficacité
- Utilisez AGENTS.md pour réduire les explications répétées.
- Utilisez Skills pour encapsuler les prompts courants.
- Utilisez des images pour transmettre des informations visuelles
- Fournir des informations complètes sur l'erreur
FAQ
Q : Et si Codex comprend mal ?
Fournissez une description plus claire, ajoutez du contexte ou utilisez des exemples de référence.
Q : Comment faire en sorte que Codex suive les conventions du projet ?
Créez un fichier AGENTS.md pour définir les conventions, et Codex les suivra automatiquement.
Q : Comment gérer les tâches complexes ?
Utilisez le mode /plan pour établir un plan, exécuter étape par étape et vérifier.
Q : Quelles sont les limites de la saisie d’images ?
Prend en charge les formats PNG, JPG et WebP ; une résolution modérée est recommandée (ni trop petite ni trop grande).
autres extensions