Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design
Codex

Anwendungsfall für Codex

Große Codebasen verstehen

Verfolge den Weg einer Anfrage, verschaffe dir einen Überblick über unbekannte Module und finde schnell die richtigen Dateien.

Schwierigkeitsgrad Easy
Zeithorizont 5m

Mit Codex verschaffst du dir einen Überblick über eine unbekannte Codebasis. Codex erklärt dir, welche Aufgaben die einzelnen Module übernehmen und wie die Daten fließen. Du erfährst auch, welche Dateien du als Nächstes lesen solltest, bevor du den Code änderst.

Besonders geeignet für

  • Entwickelnde, die sich in ein neues Repository oder einen neuen Dienst einarbeiten
  • Alle, die verstehen möchten, wie eine Funktion arbeitet, bevor sie daran etwas ändern

Inhalt

    ← Alle Anwendungsfälle

    Große Codebasen verstehen

    Verfolge den Weg einer Anfrage, verschaffe dir einen Überblick über unbekannte Module und finde schnell die richtigen Dateien.

    Mit Codex verschaffst du dir einen Überblick über eine unbekannte Codebasis. Codex erklärt dir, welche Aufgaben die einzelnen Module übernehmen und wie die Daten fließen. Du erfährst auch, welche Dateien du als Nächstes lesen solltest, bevor du den Code änderst.

    Easy
    5m

    Mit Codex verschaffst du dir einen Überblick über eine unbekannte Codebasis. Codex erklärt dir, welche Aufgaben die einzelnen Module übernehmen und wie die Daten fließen. Du erfährst auch, welche Dateien du als Nächstes lesen solltest, bevor du den Code änderst.

    Easy
    5m

    Weiterführende Links

    Besonders geeignet für

    • Entwickelnde, die sich in ein neues Repository oder einen neuen Dienst einarbeiten
    • Alle, die verstehen möchten, wie eine Funktion arbeitet, bevor sie daran etwas ändern

    Prompt für den Einstieg

    Explain how the request flows through <name of the system area> in the codebase. Include: - which modules own what - where data is validated - the top gotchas to watch for before making changes End with the files I should read next.
    Explain how the request flows through <name of the system area> in the codebase. Include: - which modules own what - where data is validated - the top gotchas to watch for before making changes End with the files I should read next.

    Einführung

    Wenn du dich in ein neues Repository oder eine dir unbekannte Funktion einarbeitest, kann dir Codex helfen, dich zurechtzufinden, bevor du den Code änderst. Über einen ersten Überblick hinaus kannst du nachvollziehen, welchen Weg eine Anfrage durch den Code nimmt, welche Aufgaben die einzelnen Module übernehmen und welche Dateien du als Nächstes lesen solltest.

    So gehst du vor

    Wenn du neu in einem Projekt bist, kannst du Codex zunächst bitten, dir die gesamte Codebasis zu erklären.

    Erklär mir dieses Repository

    Wenn du eine bestehende Codebasis um eine Funktion erweitern möchtest, kannst du dir von Codex den entsprechenden Teil des Systems erklären lassen. Je genauer du eingrenzt, was du verstehen möchtest, desto konkreter fällt die Erklärung aus.

    1. Zeig Codex die relevanten Dateien oder Verzeichnisse oder benenne den Funktionsbereich, den du verstehen möchtest.
    2. Bitte Codex, den Weg einer Anfrage nachzuzeichnen und zu erklären, welche Module für Geschäftslogik, Transport, Persistenz oder Benutzeroberfläche zuständig sind.
    3. Bevor du etwas bearbeitest, frag, an welchen Stellen im Code die Validierung stattfindet, Seiteneffekte auftreten oder sich der Zustand ändert.
    4. Frag zum Schluss, welche Dateien du als Nächstes lesen solltest und an welchen Stellen Änderungen riskant sind.

    Eine hilfreiche Antwort zeigt dir, wie die Teile der Codebasis zusammenhängen. Eine Liste von Dateinamen allein reicht dafür nicht aus. Bevor du mit der Bearbeitung beginnst, sollte Codex dir den zentralen Ablauf erklärt, auf kritische Stellen hingewiesen und die Dateien oder Prüfungen genannt haben, die jetzt wichtig sind.

    Mögliche Folgefragen

    Frag nach der ersten Antwort weiter, bis die Erklärung so konkret ist, dass du dir die erste Änderung zutraust. Mit gezielten Folgefragen bringst du Codex dazu, Annahmen und versteckte Abhängigkeiten zu benennen und zu erklären, welche Prüfungen nach einer Änderung wichtig sind.

    • Welches Modul enthält die eigentliche Geschäftslogik und welche Module sind für den Transport oder die Benutzeroberfläche zuständig?
    • Wo findet die Validierung statt und welche Annahmen muss der Code dort sicherstellen?
    • Welche zugehörigen Dateien oder Hintergrundjobs kann ich leicht übersehen, wenn ich diesen Ablauf ändere?
    • Welche Tests oder Prüfungen sollte ich ausführen, nachdem ich diesen Bereich geändert habe?

    Verwandte Anwendungsfälle