For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale
Theme
Codex

Codex use case

Comprendre une vaste base de code

Suivez le parcours des requêtes, cartographiez les modules que vous découvrez et trouvez rapidement les bons fichiers.

Difficulty Easy
Time horizon 5m

Utilisez Codex pour cartographier une base de code que vous découvrez. Il vous explique le rôle de chaque module et la façon dont les données circulent, puis vous indique quels fichiers lire avant de modifier le code.

Best for

  • Les ingénieurs qui viennent d’arriver et prennent en main un dépôt ou un service
  • Toute personne qui souhaite comprendre le fonctionnement d’une fonctionnalité avant de la modifier

Contents

    ← All use cases

    Comprendre une vaste base de code

    Suivez le parcours des requêtes, cartographiez les modules que vous découvrez et trouvez rapidement les bons fichiers.

    Utilisez Codex pour cartographier une base de code que vous découvrez. Il vous explique le rôle de chaque module et la façon dont les données circulent, puis vous indique quels fichiers lire avant de modifier le code.

    Easy
    5m

    Utilisez Codex pour cartographier une base de code que vous découvrez. Il vous explique le rôle de chaque module et la façon dont les données circulent, puis vous indique quels fichiers lire avant de modifier le code.

    Easy
    5m

    Best for

    • Les ingénieurs qui viennent d’arriver et prennent en main un dépôt ou un service
    • Toute personne qui souhaite comprendre le fonctionnement d’une fonctionnalité avant de la modifier

    Starter prompt

    Expliquez, à partir du code, le parcours d’une requête dans <name of the system area>. Précisez les points suivants : - le rôle de chaque module - les endroits où les données sont validées - les principaux pièges à éviter avant de modifier le code Terminez par la liste des fichiers que je devrais lire ensuite.
    Expliquez, à partir du code, le parcours d’une requête dans <name of the system area>. Précisez les points suivants : - le rôle de chaque module - les endroits où les données sont validées - les principaux pièges à éviter avant de modifier le code Terminez par la liste des fichiers que je devrais lire ensuite.

    Introduction

    Lorsque vous découvrez un dépôt ou que vous devez intervenir sur une fonctionnalité que vous connaissez mal, Codex peut vous aider à prendre vos repères avant de modifier le code. Au-delà d’une vue d’ensemble, l’objectif est de suivre le parcours d’une requête, de comprendre le rôle de chaque module et de repérer les fichiers à lire ensuite.

    Marche à suivre

    Si vous débutez sur un projet, commencez par demander à Codex de vous expliquer l’ensemble du code source :

    Explique-moi comment fonctionne ce dépôt

    Si vous devez ajouter une fonctionnalité à un projet existant, demandez à Codex de vous expliquer la partie du système concernée. Plus votre demande est ciblée, plus l’explication sera concrète :

    1. Indiquez à Codex les fichiers, les répertoires ou la partie du projet que vous cherchez à comprendre.
    2. Demandez-lui de retracer le parcours d’une requête et de préciser quels modules gèrent la logique métier, le transport, la persistance des données ou l’interface utilisateur.
    3. Avant toute modification, demandez-lui de repérer les endroits du code où s’effectue la validation, où se produisent les effets de bord et où l’état change.
    4. Pour finir, demandez-lui quels fichiers lire ensuite et quelles parties du code sont délicates à modifier.

    Une réponse utile montre comment les différentes parties du code s’articulent. Une simple liste de noms de fichiers ne suffit pas. À ce stade, Codex devrait vous avoir expliqué le parcours principal d’une requête, signalé les points sensibles et indiqué les fichiers à lire ou les vérifications à effectuer avant de modifier le code.

    Questions pour approfondir

    Après la première réponse de Codex, poursuivez l’échange jusqu’à ce que l’explication soit assez précise pour que vous puissiez effectuer une première modification avec confiance. Posez des questions qui amènent Codex à expliciter ses hypothèses, à repérer les dépendances cachées et à préciser les vérifications à effectuer après une modification.

    • Quel module contient la logique métier proprement dite et lesquels gèrent le transport ou l’interface utilisateur ?
    • Où s’effectue la validation et quelles hypothèses le code vérifie-t-il à cet endroit ?
    • Quels fichiers associés ou quelles tâches en arrière-plan risquent de m’échapper si je modifie le traitement de la requête ?
    • Quels tests ou vérifications dois-je effectuer après avoir modifié cette partie du code ?

    Related use cases