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

Codex use case

Comprende grandes bases de código

Sigue el recorrido de las solicitudes, identifica cómo se organizan los módulos que aún no conoces y encuentra rápidamente los archivos que necesitas.

Difficulty Easy
Time horizon 5m

Usa Codex para explorar la estructura de una base de código que aún no conoces. Pídele que te explique qué hace cada módulo, cómo fluyen los datos y qué archivos conviene leer antes de editar el código.

Best for

  • Ingenieros que empiezan a trabajar con un repositorio o servicio nuevo
  • Quienes quieren entender cómo funciona una característica antes de modificarla

Contents

    ← All use cases

    Comprende grandes bases de código

    Sigue el recorrido de las solicitudes, identifica cómo se organizan los módulos que aún no conoces y encuentra rápidamente los archivos que necesitas.

    Usa Codex para explorar la estructura de una base de código que aún no conoces. Pídele que te explique qué hace cada módulo, cómo fluyen los datos y qué archivos conviene leer antes de editar el código.

    Easy
    5m

    Usa Codex para explorar la estructura de una base de código que aún no conoces. Pídele que te explique qué hace cada módulo, cómo fluyen los datos y qué archivos conviene leer antes de editar el código.

    Easy
    5m

    Best for

    • Ingenieros que empiezan a trabajar con un repositorio o servicio nuevo
    • Quienes quieren entender cómo funciona una característica antes de modificarla

    Starter prompt

    Explica qué recorrido sigue la solicitud al pasar por <name of the system area> en la base de código. Incluye: - de qué se encarga cada módulo - dónde se validan los datos - qué problemas importantes podría pasar por alto antes de hacer cambios Al final, indica qué archivos debería leer a continuación.
    Explica qué recorrido sigue la solicitud al pasar por <name of the system area> en la base de código. Incluye: - de qué se encarga cada módulo - dónde se validan los datos - qué problemas importantes podría pasar por alto antes de hacer cambios Al final, indica qué archivos debería leer a continuación.

    Introducción

    Si es la primera vez que trabajas en un repositorio o te asignan una funcionalidad que no conoces, Codex puede ayudarte a orientarte antes de empezar a modificar el código. Además de obtener un resumen general, el objetivo es seguir el recorrido de las solicitudes, entender de qué se encarga cada módulo e identificar qué archivos conviene leer a continuación.

    Cómo usar Codex

    Si acabas de incorporarte a un proyecto, puedes empezar por pedirle a Codex que te explique toda la base de código:

    Explícame este repositorio

    Si necesitas agregar una funcionalidad a una base de código existente, puedes pedirle a Codex que te explique una parte específica del sistema. Cuanto mejor delimites tu solicitud, más concreta será la explicación:

    1. Comparte con Codex los archivos o directorios relevantes, o indícale qué parte de la funcionalidad quieres entender.
    2. Pídele que siga el recorrido de una solicitud y explique qué módulos se encargan de la lógica de negocio, el transporte, la persistencia o la interfaz de usuario.
    3. Antes de editar el código, pregunta dónde se realizan las validaciones y dónde se producen los efectos secundarios o las transiciones de estado.
    4. Por último, pregunta qué archivos conviene leer a continuación y en qué partes es más arriesgado hacer cambios.

    Para ayudarte a familiarizarte con el proyecto, la respuesta debe darte un mapa concreto que vaya más allá de una lista de nombres de archivos. Al terminar, Codex debería haberte explicado el flujo principal, señalado las partes donde hay riesgo e indicado qué archivos leer o qué comprobaciones hacer antes de empezar a editar.

    Preguntas de seguimiento

    Después de la primera explicación de Codex, sigue haciendo preguntas hasta que tengas suficiente detalle para hacer el primer cambio con confianza. Las buenas preguntas de seguimiento suelen llevar a Codex a identificar los supuestos, las dependencias ocultas y las comprobaciones que importan después de un cambio.

    • ¿Qué módulo implementa la lógica de negocio y cuáles se encargan del transporte o de la interfaz de usuario?
    • ¿Dónde se realizan las validaciones y cómo se garantiza allí que se cumplan los supuestos del código?
    • ¿Qué archivos relacionados o tareas en segundo plano podría pasar por alto si modifico este flujo?
    • ¿Qué pruebas o comprobaciones debería ejecutar después de modificar esta parte del sistema?

    Related use cases