Best Practices für Codex-Prompts
Beherrsche Prompt-Techniken, damit Codex Ihre Absicht genauer versteht und Aufgaben effizient erledigt.
Grundlegende Prompt-Struktur
Ein guter Prompt enthält die folgenden Elemente:
Grundlegende Elemente
| Elemente | Beschreibung | Beispiel |
|---|---|---|
| Aufgabenbeschreibung | Was Sie tun möchten | "Benutzer-Login-Funktionalität implementieren" |
| Kontext | Zugehörige Hintergrundinformationen | "Verwende das vorhandene Auth-Modul" |
| Einschränkungen | Einschränkungen und Anforderungen | "Muss mit vorhandenen APIs kompatibel sein" |
| Erwartetes Ergebnis | Spezifische Ausgabe | "JWT-Token zurückgeben" |
Strukturierter Prompt
Vollständiges Prompt-Beispiel
Benutzer-Login-API-Endpunkt implementieren
# Kontext
- Das Projekt verwendet das FastAPI-Framework
- Das vorhandene Auth-Modul übernimmt die Authentifizierungslogik
- Die Datenbank verwendet PostgreSQL
# Einschränkungen
- Verwenden Sie das vorhandene JWT-Dienstprogramm, um das Token zu generieren
- Passwörter werden mit bcrypt verifiziert
- Anfrage-Logging muss hinzugefügt werden
# Erwartetes Ergebnis
- Pfad: POST /api/auth/login
- Anfrage-Body: {"email": "...", "password": "..."}
- Erfolgsantwort: {"token": "...", "user": {...}}
- Fehlerantwort: {"error": "..."}
Prinzip der Aufgabenzerlegung
Komplexe Aufgaben sollten in kleine Schritte zerlegt und Schritt für Schritt erledigt werden.
Zerlegungsprinzipien
- Jeder Schritt hat ein klares Ziel
- Abhängigkeiten zwischen den Schritten sind klar
- Ergebnisse nach jedem Schritt überprüfen
- Bei Problemen kann zurückgerollt werden
Beispiel für Zerlegung
Aufgabenzerlegung
"Implementiere ein vollständiges Benutzerauthentifizierungssystem"
# In kleine Aufgaben zerlegen
Schritte1:"Entwirf die Datenstruktur des Authentifizierungssystems, einschließlich der Benutzertabelle und der Token-Tabelle"
Schritte2:"Implementiere die Benutzerregistrierungsfunktion, einschließlich Passwortverschlüsselung und -überprüfung"
Schritte3:"Implementiere die Benutzeranmeldefunktion und generiere JWT-Token"
Schritte4:"Implementiere Token-Verifizierungs-Middleware"
Schritte5:"Implementiere die Benutzerabmeldefunktion"
Schritte6:"Schreibe Tests für das Authentifizierungssystem"
Schritte7:"Aktualisiere die API-Dokumentation"
Die Verwendung des /plan-Modus kann Codex dabei helfen, komplexe Aufgaben automatisch zu zerlegen.
Kontextinformationen bereitstellen
Ausreichender Kontext hilft Codex, den Projektstatus genauer zu verstehen.
Wichtiger Kontext
| Type | Beschreibung | Wann bereitstellen |
|---|---|---|
| Tech-Stack | Framework-, Sprach- und Bibliotheksversionen | Erstmalige Aufgaben oder neue Module |
| Projektstruktur | Modulstandort, Namenskonventionen | Umfasst Änderungen an mehreren Dateien |
| Vorhandener Code | Zugehörige Funktionen, Klassen, Module | Erfordert Kompatibilität oder Erweiterung |
| Einschränkungen | Kompatibilität, Anforderungen | Hat besondere Einschränkungen |
Möglichkeiten zur Bereitstellung von Kontext
Kontext bereitstellen
"Das Projekt verwendet Django 4.2 und die Datenbank ist PostgreSQL 15"
# Auf vorhandenen Code verweisen
Verweisen Sie auf die Validierungslogik in src/utils/validator.py
# Datei angeben
Ändern Sie src/api/users.py und halten Sie den Stil konsistent mit anderen APIs
# AGENTS.md automatisch bereitgestellt
Erstellen Sie die Datei AGENTS.md, Codex liest automatisch die Projektrichtlinien
Umgang mit Fehlermeldungen
Codex kann anhand von Fehlermeldungen schnell Probleme lokalisieren.
Vollständige Fehlerinformationen bereitstellen
Fehlerbehandlung
Beim Ausführen der Tests ist ein Fehler aufgetreten:
AssertionError: Status 200 erwartet, aber 500 erhalten
bei test_login.py:45
in test_successful_login
Vollständiger Traceback:
...
Analysiere die Ursache und behebe sie
# Screenshot-Hilfe
Fehler-Screenshots anhängen, Codex kann sie direkt ansehen
Elemente der Fehlermeldung
- Fehlertypen und Fehlermeldungen
- Vollständiger Stacktrace
- Auslösebedingungen (welche Operation ausgeführt wurde)
- Erwartetes Ergebnis vs. tatsächliches Ergebnis
Bildeingabe
Codex unterstützt Bildeingabe, geeignet zur Übermittlung visueller Informationen.
Anwendbare Szenarien
| Szenarien | Beschreibung |
|---|---|
| Fehler-Screenshot | Screenshots, die die Fehleroberfläche oder Logs zeigen |
| Design-Mockup | UI-Design-Mockups in Code umwandeln |
| Architekturdiagramm | Architekturdiagramm erklären und umsetzen |
| Daten-Diagramm | Diagrammdaten analysieren |
Bildeingabemethode
Bilder verwenden
codex -i screenshot.png
codex --image design.png Implementiere die Seite basierend auf dem Design-Mockup
# App/IDE
Bilder direkt in den Konversationsbereich einfügen oder hineinziehen
# Mehrere Bilder
codex -i img1.png -i img2.png Vergleiche die Unterschiede zwischen diesen beiden Design-Mockups
Iterative Optimierung
Die Codequalität schrittweise durch Iteration optimieren.
Iterationsprozess
- Codex schließt die erste Implementierung ab
- Ergebnisse prüfen, Verbesserungen vorschlagen
- Codex nimmt Anpassungen basierend auf Feedback vor
- Verbesserungseffekt überprüfen
- Wiederholen, bis zufriedenstellend
Iterative Optimierung
Benutzerlisten-API mit Paginierungsunterstützung implementieren
# Überprüfen und Verbesserungen vorschlagen
Sortierfunktion hinzufügen, um Sortierung nach Erstellungszeit zu unterstützen
# Optimierung fortsetzen
Suchfunktion hinzufügen, um Suche nach Benutzername zu unterstützen
# Leistungsoptimierung
Abfrageleistung optimieren und Indizes hinzufügen
Mehrdeutigkeit vermeiden
Klare Prompts reduzieren Missverständnisse und Nacharbeit.
Beispiele für Mehrdeutigkeit
Mehrdeutigkeit vermeiden
Ändere diese Funktion
# Klarer Prompt (gut)
Ändere die Funktion format_date in src/utils/helper.py
# Vager Prompt (schlecht)
Mach es schneller
# Klarer Prompt (gut)
Optimiere die Funktion query_users, um die Abfragezeit von 500ms auf unter 100ms zu reduzieren
# Vager Prompt (schlecht)
Füge ein Feature hinzu
# Klarer Prompt (gut)
Füge der Benutzer-API eine Batch-Löschfunktion hinzu, die eine Liste von Benutzer-IDs akzeptiert
Verwende Referenzbeispiele
Stelle Referenzcode oder Dokumentation bereit, damit Codex den erwarteten Stil versteht.
Referenz bereitstellen
Orientieren Sie sich am Stil von src/api/products.py, um die Benutzer-API zu implementieren
# Referenzdokumentation
Implementieren Sie gemäß dem OpenAPI-Spezifikationsdokument docs/api-spec.yaml
# Referenzbeispiel
Geben Sie die Antwort in diesem Format zurück:
{
'success': true,
'data': {...},
'message': '...'
}"
Gängige Prompt-Vorlagen
Vorlage für Feature-Entwicklung
Feature-Entwicklung
Requirements:
- Verwende [Technologie/Bibliothek]
- Sei kompatibel mit [bestehendem System]
- Schließe [Edge-Case-Behandlung] ein
- Gib [Antwortformat] zurück
Referenz: [Pfad zu einem ähnlichen bestehenden Feature]
Vorlage zur Fehlerbehebung
Fehlerbehebung
Auslösebedingungen: [die Umstände, unter denen es auftritt]
Fehlermeldung:
[Vollständiger Fehler-Stack]
Erwartetes Verhalten: [was das korrekte Ergebnis sein sollte]
Bitte analysiere die Ursache und behebe sie, ohne andere Funktionen zu beeinträchtigen.
Code-Review-Vorlage
Code-Review
# Beispiel
/review src/auth/ auf Sicherheitsprobleme
/review HEAD~5..HEAD auf Performance-Regressionen
Zusammenfassung der Best Practices
Grundprinzipien
- Sei präzise und klar, vermeide vage Beschreibungen
- Gib ausreichend Kontext an
- Zerlege komplexe Aufgaben zur Ausführung
- Iterative Optimierung, schrittweise Verbesserung
- Überprüfe Ergebnisse, um Korrektheit zu gewährleisten
Effizienztipps
- Verwende AGENTS.md, um wiederholte Erklärungen zu reduzieren.
- Verwende Skills, um häufige Prompts zu kapseln.
- Verwende Bilder, um visuelle Informationen zu vermitteln
- Vollständige Fehlerinformationen bereitstellen
FAQ
F: Was, wenn Codex etwas missversteht?
Gib eine klarere Beschreibung an, ergänze Kontext oder verwende Referenzbeispiele.
F: Wie kann ich Codex dazu bringen, Projektkonventionen zu befolgen?
Erstelle eine AGENTS.md-Datei, um Konventionen zu definieren, und Codex wird sie automatisch befolgen.
F: Wie gehe ich mit komplexen Aufgaben um?
Verwende den /plan-Modus, um einen Plan zu erstellen, ihn Schritt für Schritt auszuführen und zu überprüfen.
F: Was sind die Einschränkungen bei der Bildeingabe?
Unterstützt die Formate PNG, JPG, WebP; eine moderate Auflösung wird empfohlen (nicht zu klein oder zu groß).
Weitere Erweiterungen