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
Codex

Codex use case

Crea un recorrido guiado con IA

Ayuda a los usuarios a aprender a usar tu aplicación con un recorrido que se adapta a medida que avanzan.

Difficulty Avanzado
Time horizon De larga duración

Usa Codex para agregar un recorrido basado en WebMCP a tu aplicación web. Resalta el siguiente control, explica qué hacer y adapta las indicaciones al estado actual del usuario mientras este completa los pasos por su cuenta.

Ideal para

  • Equipos que ayudan a los nuevos usuarios a completar su primer flujo de trabajo en una aplicación web.
  • Flujos de introducción a la aplicación que cambian según el estado de inicio de sesión, los servicios conectados o los paneles abiertos.
  • Tareas en las que los usuarios deberían aprender a usar los controles y realizar las acciones por su cuenta.

Contents

    ← Todos los casos de uso

    Crea un recorrido guiado con IA

    Ayuda a los usuarios a aprender a usar tu aplicación con un recorrido que se adapta a medida que avanzan.

    Usa Codex para agregar un recorrido basado en WebMCP a tu aplicación web. Resalta el siguiente control, explica qué hacer y adapta las indicaciones al estado actual del usuario mientras este completa los pasos por su cuenta.

    Avanzado
    De larga duración

    Usa Codex para agregar un recorrido basado en WebMCP a tu aplicación web. Resalta el siguiente control, explica qué hacer y adapta las indicaciones al estado actual del usuario mientras este completa los pasos por su cuenta.

    Avanzado
    De larga duración

    Ideal para

    • Equipos que ayudan a los nuevos usuarios a completar su primer flujo de trabajo en una aplicación web.
    • Flujos de introducción a la aplicación que cambian según el estado de inicio de sesión, los servicios conectados o los paneles abiertos.
    • Tareas en las que los usuarios deberían aprender a usar los controles y realizar las acciones por su cuenta.

    Prompt inicial

    Agrega un recorrido guiado a [web app/repository] para que Codex pueda mostrarles a los usuarios cómo [complete one specific workflow]. Revisa primero la interfaz, la gestión del estado y la documentación existentes de la aplicación. Usa WebMCP para que Codex pueda: - identificar los elementos del recorrido mediante IDs estables y semánticos, etiquetas y descripciones - resaltar un elemento con una breve explicación y quitar el resaltado - leer el estado de la interfaz necesario para elegir el siguiente paso - esperar a que el usuario actúe y luego leer el estado actualizado - leer las instrucciones de la aplicación y la documentación pertinente El usuario debería completar el flujo de trabajo por su cuenta. Mantén las herramientas del recorrido separadas de las que realizan acciones y conserva la autenticación y las verificaciones de permisos existentes de la aplicación. Empieza con un flujo completo. Reutiliza los componentes y el sistema de diseño existentes. Prueba el recorrido en un entorno de navegador donde Codex pueda llamar a las herramientas de WebMCP, incluidos distintos estados iniciales, un paso cancelado y un elemento que aún no sea visible. Resume qué cambió, qué verificaste y qué configuración sigue pendiente. No despliegues ni publiques sin mi aprobación.
    Agrega un recorrido guiado a [web app/repository] para que Codex pueda mostrarles a los usuarios cómo [complete one specific workflow]. Revisa primero la interfaz, la gestión del estado y la documentación existentes de la aplicación. Usa WebMCP para que Codex pueda: - identificar los elementos del recorrido mediante IDs estables y semánticos, etiquetas y descripciones - resaltar un elemento con una breve explicación y quitar el resaltado - leer el estado de la interfaz necesario para elegir el siguiente paso - esperar a que el usuario actúe y luego leer el estado actualizado - leer las instrucciones de la aplicación y la documentación pertinente El usuario debería completar el flujo de trabajo por su cuenta. Mantén las herramientas del recorrido separadas de las que realizan acciones y conserva la autenticación y las verificaciones de permisos existentes de la aplicación. Empieza con un flujo completo. Reutiliza los componentes y el sistema de diseño existentes. Prueba el recorrido en un entorno de navegador donde Codex pueda llamar a las herramientas de WebMCP, incluidos distintos estados iniciales, un paso cancelado y un elemento que aún no sea visible. Resume qué cambió, qué verificaste y qué configuración sigue pendiente. No despliegues ni publiques sin mi aprobación.

    Introducción

    Algunos flujos de trabajo son más fáciles de aprender cuando alguien te muestra adónde ir y qué seleccionar. Usa Codex para crear un recorrido que guíe a los usuarios por tu aplicación web mientras realizan las acciones por su cuenta.

    Con herramientas de WebMCP para los controles, el estado y la documentación de tu aplicación, Codex puede elegir la siguiente instrucción según lo que ve el usuario. Un usuario que no ha conectado un servicio necesita un primer paso distinto al de alguien que ya completó la configuración.

    Cómo usarlo

    1. Abre el repositorio de tu aplicación en Codex y elige un flujo de trabajo para guiar al usuario, como conectar un servicio o agregar una carpeta.
    2. Proporciona la documentación pertinente y describe los estados iniciales que el recorrido debería contemplar.
    3. Ejecuta el prompt inicial de esta página para agregar elementos del recorrido, herramientas para consultar el estado de la interfaz y acceso a las instrucciones de la aplicación.
    4. Prueba el flujo en un entorno de navegador donde Codex pueda llamar a las herramientas de WebMCP de tu aplicación. Pídele a Codex que te guíe y luego completa cada paso por tu cuenta.

    Limita el alcance del primer recorrido. Verifica que pueda guiar a un usuario desde la configuración hasta completar el flujo antes de agregar más flujos de trabajo.

    Ejemplo: agrega una carpeta de Google Drive en Runme

    En Runme, los usuarios editan cuadernos y usan un explorador de archivos para agregar carpetas de Google Drive y navegar por sus archivos. El recorrido ayuda a un nuevo usuario a encontrar esos controles y aprender el flujo.

    Para conocer más sobre Runme, puedes leer Automatizar tareas repetitivas en OpenAI con Codex.

    Mira cómo Codex resalta los controles de Runme y explica para qué sirven. Las siguientes capturas de pantalla muestran un recorrido distinto, centrado en la tarea de agregar una carpeta de Google Drive.

    El recorrido de Google Drive comienza con una solicitud:

    Muéstrame cómo agregar una carpeta de Google Drive.

    Conecta Google Drive

    Codex comprueba si Google Drive está conectado. Si no lo está, Codex resalta Conectar Google Drive y le pide al usuario que lo seleccione y complete la conexión.

    Codex resalta Conectar Google Drive en Runme y explica cómo empezar.

    Abre el explorador de archivos

    Una vez completada la conexión, Codex guía al usuario al explorador de archivos. La siguiente instrucción se adapta al estado actualizado de la aplicación.

    Codex resalta el control para abrir el explorador de archivos de Runme.

    Agrega la carpeta

    Una vez que el usuario expande la barra de herramientas, Codex resalta el control para agregar una carpeta de Google Drive. El usuario mantiene el control de la interacción y aprende dónde encontrar ese control la próxima vez.

    Codex resalta el control para agregar una carpeta de Google Drive en Runme.

    Dale a Codex el contexto para guiar a los usuarios

    La implementación de Runme proporciona tres tipos de contexto: elementos del recorrido, estado de la aplicación y documentación. Los nombres de las herramientas que se muestran a continuación corresponden a Runme; adapta esas mismas funciones a tu aplicación.

    Permite detectar los controles

    Asigna a los elementos del recorrido valores de data-tour-id estables y semánticos, con una etiqueta y una descripción para cada uno. Runme expone estos controles a través de tres herramientas de WebMCP:

    • listTargets enumera los elementos registrados, sus IDs, etiquetas y descripciones.
    • showTourStep({ target, title?, message, placement? }) resalta un elemento y muestra una explicación.
    • dismiss quita el resaltado.

    Esto le permite a Codex identificar un control y explicar para qué sirve sin realizar su acción por el usuario.

    Lee el estado y espera al usuario

    Runme mantiene el estado relacionado con el recorrido fuera de React y lo expone a través de un controlador. Su herramienta getUiSnapshot proporciona el estado actual de la interfaz, incluido el estado de inicio de sesión. waitForUiChange(...) permite que Codex espere un cambio, como que el usuario seleccione el control resaltado.

    Pídele a Codex que vuelva a leer el estado después de cada interacción. El avance del recorrido debería depender de lo que ocurrió en la aplicación, no de si Codex ya mostró una instrucción.

    Incluye las instrucciones en la aplicación

    Runme incluye documentación en Markdown junto con la aplicación y la pone a disposición a través de WebMCP:

    • readInstructionsForAIAgents explica cómo debería interactuar Codex con la aplicación y sus herramientas.
    • listDocumentation() enumera las páginas disponibles y sus descripciones.
    • getDocumentation({ name }) devuelve una página seleccionada en formato Markdown.

    Las instrucciones y herramientas del recorrido se pueden distribuir junto con la aplicación, sin un complemento de Codex aparte para el recorrido.

    Revisa el recorrido

    Prueba la misma solicitud desde distintos estados iniciales. Comprueba que el recorrido omita la configuración ya completada, espere al usuario y actualice sus indicaciones cuando cambie la interfaz.

    También prueba un paso cancelado y un control que aún no sea visible. Codex debería explicar qué falta o elegir un siguiente paso válido. No debería afirmar que una acción se completó correctamente solo porque resaltó un botón.

    Mantén la autenticación, las verificaciones de permisos y las acciones del usuario en el flujo existente de la aplicación. El recorrido debería ayudar a los usuarios a entender la interfaz sin eludir esos controles.

    Sugerencias para continuar

    Una vez que funcione el primer flujo, continúa en el mismo chat:

    • “Prueba este recorrido cuando Google Drive ya esté conectado y el explorador de archivos esté cerrado”.
    • “Maneja el caso de un usuario que cancela un paso y luego pide continuar el recorrido”.
    • “Agrega un recorrido para [next workflow], reutilizando los elementos de destino y las herramientas de estado existentes”.

    Casos de uso relacionados