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

Codex use case

Créez un guide interactif basé sur l’IA

Aidez les utilisateurs à prendre en main votre application avec un parcours guidé qui s’adapte à leur progression.

Difficulty Avancé
Time horizon Longue durée

Utilisez Codex pour ajouter un parcours guidé reposant sur WebMCP à votre application web. Mettez en évidence la prochaine commande à utiliser, expliquez la marche à suivre et adaptez les instructions à la situation actuelle de l’utilisateur pendant qu’il réalise lui-même les étapes.

Idéal pour

  • Les équipes qui aident les nouveaux utilisateurs à réaliser leur premier workflow dans une application web.
  • Les parcours de prise en main qui évoluent selon le statut de connexion, les services connectés ou les panneaux ouverts.
  • Les tâches pour lesquelles les utilisateurs doivent apprendre à utiliser les commandes et effectuer eux-mêmes les actions.

Contents

    ← Tous les cas d’utilisation

    Créez un guide interactif basé sur l’IA

    Aidez les utilisateurs à prendre en main votre application avec un parcours guidé qui s’adapte à leur progression.

    Utilisez Codex pour ajouter un parcours guidé reposant sur WebMCP à votre application web. Mettez en évidence la prochaine commande à utiliser, expliquez la marche à suivre et adaptez les instructions à la situation actuelle de l’utilisateur pendant qu’il réalise lui-même les étapes.

    Avancé
    Longue durée

    Utilisez Codex pour ajouter un parcours guidé reposant sur WebMCP à votre application web. Mettez en évidence la prochaine commande à utiliser, expliquez la marche à suivre et adaptez les instructions à la situation actuelle de l’utilisateur pendant qu’il réalise lui-même les étapes.

    Avancé
    Longue durée

    Idéal pour

    • Les équipes qui aident les nouveaux utilisateurs à réaliser leur premier workflow dans une application web.
    • Les parcours de prise en main qui évoluent selon le statut de connexion, les services connectés ou les panneaux ouverts.
    • Les tâches pour lesquelles les utilisateurs doivent apprendre à utiliser les commandes et effectuer eux-mêmes les actions.

    Prompt de démarrage

    Ajoutez un parcours guidé à [web app/repository] afin que Codex puisse montrer aux utilisateurs comment [complete one specific workflow]. Commencez par examiner l’interface, la gestion de l’état et la documentation existantes de l’application. Utilisez WebMCP pour permettre à Codex de : - repérer les cibles du parcours à l’aide d’identifiants stables et sémantiques, de libellés et de descriptions - mettre une cible en évidence avec une courte explication et retirer cette mise en évidence - lire l’état de l’interface nécessaire pour choisir l’étape suivante - attendre que l’utilisateur agisse, puis lire l’état mis à jour - lire les instructions de l’application et la documentation pertinente L’utilisateur doit réaliser lui-même le workflow. Gardez les outils du parcours séparés de ceux qui exécutent des actions et conservez l’authentification et les vérifications des permissions déjà en place dans l’application. Commencez par un seul parcours complet. Réutilisez les composants et le système de design existants. Testez le parcours guidé dans un environnement de navigateur où Codex peut appeler les outils WebMCP, en couvrant différents états initiaux, une étape annulée et une cible qui n’est pas encore visible. Résumez les modifications, les vérifications effectuées et les éventuelles étapes de configuration restantes. Ne déployez et ne publiez rien sans mon approbation.
    Ajoutez un parcours guidé à [web app/repository] afin que Codex puisse montrer aux utilisateurs comment [complete one specific workflow]. Commencez par examiner l’interface, la gestion de l’état et la documentation existantes de l’application. Utilisez WebMCP pour permettre à Codex de : - repérer les cibles du parcours à l’aide d’identifiants stables et sémantiques, de libellés et de descriptions - mettre une cible en évidence avec une courte explication et retirer cette mise en évidence - lire l’état de l’interface nécessaire pour choisir l’étape suivante - attendre que l’utilisateur agisse, puis lire l’état mis à jour - lire les instructions de l’application et la documentation pertinente L’utilisateur doit réaliser lui-même le workflow. Gardez les outils du parcours séparés de ceux qui exécutent des actions et conservez l’authentification et les vérifications des permissions déjà en place dans l’application. Commencez par un seul parcours complet. Réutilisez les composants et le système de design existants. Testez le parcours guidé dans un environnement de navigateur où Codex peut appeler les outils WebMCP, en couvrant différents états initiaux, une étape annulée et une cible qui n’est pas encore visible. Résumez les modifications, les vérifications effectuées et les éventuelles étapes de configuration restantes. Ne déployez et ne publiez rien sans mon approbation.

    Introduction

    Certains workflows sont plus faciles à apprendre quand quelqu’un vous montre où aller et quoi sélectionner. Utilisez Codex pour créer un parcours qui guide les utilisateurs dans votre application web tout en les laissant effectuer eux-mêmes les actions.

    Grâce aux outils WebMCP donnant accès aux commandes, à l’état et à la documentation de votre application, Codex peut choisir l’instruction suivante en fonction de ce que voit l’utilisateur. Un utilisateur qui n’a pas encore connecté de service doit commencer par une étape différente de celui qui a déjà terminé la configuration.

    Mode d’emploi

    1. Ouvrez le dépôt de votre application dans Codex et choisissez un workflow pour lequel guider les utilisateurs, comme la connexion d’un service ou l’ajout d’un dossier.
    2. Fournissez la documentation pertinente et décrivez les états initiaux que le parcours doit prendre en charge.
    3. Exécutez le prompt de démarrage de cette page pour ajouter les cibles du parcours, les outils de lecture de l’état de l’interface et l’accès aux instructions de l’application.
    4. Testez le parcours dans un environnement de navigateur où Codex peut appeler les outils WebMCP de votre application. Demandez à Codex de vous guider, puis réalisez chaque étape vous-même.

    Limitez la portée du premier parcours guidé. Vérifiez qu’il peut guider un utilisateur de la configuration jusqu’à la fin du workflow avant d’en ajouter d’autres.

    Exemple : ajoutez un dossier Google Drive dans Runme

    Dans Runme, les utilisateurs modifient des notebooks et utilisent un explorateur de fichiers pour ajouter des dossiers Google Drive et parcourir leurs fichiers. Le parcours guidé aide un nouvel utilisateur à trouver ces commandes et à apprendre la marche à suivre.

    Pour en savoir plus sur Runme, vous pouvez lire Automatiser les tâches répétitives chez OpenAI avec Codex.

    Regardez Codex mettre en évidence les commandes de Runme et expliquer leur rôle. Les captures d’écran ci-dessous montrent un parcours guidé distinct, consacré à l’ajout d’un dossier Google Drive.

    Le parcours guidé Google Drive commence par une demande :

    Montrez-moi comment ajouter un dossier Google Drive.

    Connectez Google Drive

    Codex vérifie si Google Drive est connecté. Si ce n’est pas le cas, Codex met en évidence Connecter Google Drive et demande à l’utilisateur de sélectionner cette commande et de terminer la connexion.

    Codex met en évidence la commande « Connecter Google Drive » dans Runme et explique comment commencer.

    Ouvrez l’explorateur de fichiers

    Une fois la connexion terminée, Codex guide l’utilisateur vers l’explorateur de fichiers. L’instruction suivante tient compte de l’état mis à jour de l’application.

    Codex met en évidence la commande permettant d’ouvrir l’explorateur de fichiers de Runme.

    Ajoutez le dossier

    Une fois que l’utilisateur déploie la barre d’outils, Codex met en évidence la commande permettant d’ajouter un dossier Google Drive. L’utilisateur garde la maîtrise de l’interaction et apprend où retrouver cette commande la prochaine fois.

    Codex met en évidence la commande permettant d’ajouter un dossier Google Drive dans Runme.

    Donnez à Codex le contexte nécessaire pour guider les utilisateurs

    L’implémentation de Runme fournit trois types de contexte : les cibles du parcours guidé, l’état de l’application et la documentation. Les noms d’outils ci-dessous sont ceux de Runme ; adaptez ces mêmes fonctions à votre application.

    Rendez les commandes repérables

    Attribuez aux cibles du parcours des valeurs data-tour-id stables et sémantiques, avec un libellé et une description pour chacune. Runme expose ces commandes via trois outils WebMCP :

    • listTargets répertorie les cibles enregistrées, leurs identifiants, leurs libellés et leurs descriptions.
    • showTourStep({ target, title?, message, placement? }) met une cible en évidence et affiche une explication.
    • dismiss retire la mise en évidence.

    Codex peut ainsi identifier une commande et expliquer son rôle sans exécuter l’action à la place de l’utilisateur.

    Lisez l’état et attendez que l’utilisateur agisse

    Runme conserve l’état lié au parcours guidé en dehors de React et l’expose via un contrôleur. Son outil getUiSnapshot fournit l’état actuel de l’interface, y compris le statut de connexion. waitForUiChange(...) permet à Codex d’attendre un changement, par exemple que l’utilisateur sélectionne la commande mise en évidence.

    Demandez à Codex de relire l’état après chaque interaction. La progression du parcours doit dépendre de ce qui s’est passé dans l’application, et non du fait que Codex a déjà affiché une instruction.

    Conservez les instructions avec l’application

    Runme inclut une documentation Markdown dans l’application et la rend accessible via WebMCP :

    • readInstructionsForAIAgents explique comment Codex doit interagir avec l’application et ses outils.
    • listDocumentation() répertorie les pages disponibles et leurs descriptions.
    • getDocumentation({ name }) renvoie la page sélectionnée au format Markdown.

    Les instructions et les outils du parcours guidé peuvent être livrés avec l’application, sans plugin Codex distinct pour ce parcours.

    Passez le parcours guidé en revue

    Essayez la même demande à partir de différents états initiaux. Vérifiez que le parcours saute les étapes de configuration déjà terminées, attend que l’utilisateur agisse et adapte ses instructions lorsque l’interface change.

    Testez aussi une étape annulée et une commande qui n’est pas encore visible. Codex doit expliquer ce qui manque ou choisir une étape suivante valide. Il ne doit pas affirmer qu’une action a réussi simplement parce qu’il a mis un bouton en évidence.

    Conservez l’authentification, les vérifications des permissions et les actions de l’utilisateur dans le parcours existant de l’application. Le parcours guidé doit aider les utilisateurs à comprendre l’interface sans contourner ces contrôles.

    Pour aller plus loin

    Une fois que le premier parcours fonctionne, poursuivez dans la même discussion :

    • « Testez cette visite guidée lorsque Google Drive est déjà connecté et que l’explorateur de fichiers est fermé. »
    • « Gérez le cas où un utilisateur annule une étape, puis demande à reprendre la visite guidée. »
    • « Ajoutez une visite guidée pour [next workflow], en réutilisant les cibles et les outils de lecture de l’état existants. »

    Cas d’utilisation associés