For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Codex

Codex use case

Crie um tutorial guiado por IA

Ajude os usuários a aprender a usar seu aplicativo com um tutorial que se adapta conforme eles avançam.

Difficulty Avançado
Time horizon Longa duração

Use o Codex para adicionar um tutorial baseado em WebMCP ao seu aplicativo web. Destaque o próximo controle, explique o que fazer e adapte a orientação ao estado atual do usuário enquanto ele conclui as etapas por conta própria.

Ideal para

  • Equipes que ajudam novos usuários a concluir seu primeiro fluxo de trabalho em um aplicativo web.
  • Fluxos de orientação inicial que mudam conforme o status de autenticação, os serviços conectados ou os painéis abertos.
  • Tarefas em que os usuários devem aprender a usar os controles e executar as ações por conta própria.

Contents

    ← Todos os casos de uso

    Crie um tutorial guiado por IA

    Ajude os usuários a aprender a usar seu aplicativo com um tutorial que se adapta conforme eles avançam.

    Use o Codex para adicionar um tutorial baseado em WebMCP ao seu aplicativo web. Destaque o próximo controle, explique o que fazer e adapte a orientação ao estado atual do usuário enquanto ele conclui as etapas por conta própria.

    Avançado
    Longa duração

    Use o Codex para adicionar um tutorial baseado em WebMCP ao seu aplicativo web. Destaque o próximo controle, explique o que fazer e adapte a orientação ao estado atual do usuário enquanto ele conclui as etapas por conta própria.

    Avançado
    Longa duração

    Ideal para

    • Equipes que ajudam novos usuários a concluir seu primeiro fluxo de trabalho em um aplicativo web.
    • Fluxos de orientação inicial que mudam conforme o status de autenticação, os serviços conectados ou os painéis abertos.
    • Tarefas em que os usuários devem aprender a usar os controles e executar as ações por conta própria.

    Prompt inicial

    Adicione um tutorial guiado a [web app/repository] para que o Codex possa mostrar aos usuários como [complete one specific workflow]. Primeiro, examine a interface, o gerenciamento de estado e a documentação existentes no aplicativo. Use WebMCP para permitir que o Codex: - descubra os elementos-alvo do tutorial por meio de IDs estáveis e semânticos, rótulos e descrições - destaque um elemento-alvo com uma breve explicação e remova o destaque - leia o estado da interface necessário para escolher a próxima etapa - aguarde a ação do usuário e depois leia o estado atualizado - leia as instruções do aplicativo e a documentação relevante O usuário deve concluir o fluxo de trabalho por conta própria. Mantenha as ferramentas do tutorial separadas das ferramentas que executam ações e preserve as verificações de autenticação e permissão existentes no aplicativo. Comece com um fluxo completo. Reutilize os componentes e o sistema de design existentes. Teste o tutorial em um ambiente de navegador em que o Codex possa chamar as ferramentas WebMCP. Inclua diferentes estados iniciais, uma etapa cancelada e um elemento-alvo que ainda não esteja visível. Resuma o que mudou, o que você verificou e quais configurações ainda são necessárias. Não implante nem publique sem minha aprovação.
    Adicione um tutorial guiado a [web app/repository] para que o Codex possa mostrar aos usuários como [complete one specific workflow]. Primeiro, examine a interface, o gerenciamento de estado e a documentação existentes no aplicativo. Use WebMCP para permitir que o Codex: - descubra os elementos-alvo do tutorial por meio de IDs estáveis e semânticos, rótulos e descrições - destaque um elemento-alvo com uma breve explicação e remova o destaque - leia o estado da interface necessário para escolher a próxima etapa - aguarde a ação do usuário e depois leia o estado atualizado - leia as instruções do aplicativo e a documentação relevante O usuário deve concluir o fluxo de trabalho por conta própria. Mantenha as ferramentas do tutorial separadas das ferramentas que executam ações e preserve as verificações de autenticação e permissão existentes no aplicativo. Comece com um fluxo completo. Reutilize os componentes e o sistema de design existentes. Teste o tutorial em um ambiente de navegador em que o Codex possa chamar as ferramentas WebMCP. Inclua diferentes estados iniciais, uma etapa cancelada e um elemento-alvo que ainda não esteja visível. Resuma o que mudou, o que você verificou e quais configurações ainda são necessárias. Não implante nem publique sem minha aprovação.

    Introdução

    Alguns fluxos de trabalho são mais fáceis de aprender quando alguém mostra onde ir e o que selecionar. Use o Codex para criar um tutorial que oriente os usuários pelo seu aplicativo web enquanto eles executam as ações por conta própria.

    Com ferramentas WebMCP para os controles, o estado e a documentação do seu aplicativo, o Codex pode escolher a próxima instrução com base no que o usuário vê. Quem ainda não conectou um serviço precisa de uma primeira etapa diferente de quem já concluiu a configuração.

    Como usar

    1. Abra o repositório do seu aplicativo no Codex e escolha um fluxo de trabalho para orientar, como conectar um serviço ou adicionar uma pasta.
    2. Forneça a documentação relevante e descreva os estados iniciais que o tutorial deve contemplar.
    3. Execute o prompt inicial desta página para adicionar elementos-alvo do tutorial, ferramentas de estado da interface e acesso às instruções do aplicativo.
    4. Teste o fluxo em um ambiente de navegador em que o Codex possa chamar as ferramentas WebMCP do seu aplicativo. Peça ao Codex que oriente você e depois conclua cada etapa por conta própria.

    Mantenha o escopo do primeiro tutorial restrito. Verifique se ele consegue orientar um usuário desde a configuração até a conclusão antes de adicionar mais fluxos de trabalho.

    Exemplo: adicione uma pasta do Google Drive no Runme

    No Runme, os usuários editam notebooks e usam um explorador de arquivos para adicionar pastas do Google Drive e navegar pelos arquivos. O tutorial ajuda novos usuários a encontrar esses controles e aprender o fluxo.

    Para saber mais sobre o Runme, leia Automação de tarefas repetitivas na OpenAI com o Codex.

    Veja o Codex destacar os controles do Runme e explicar para que servem. As capturas de tela abaixo mostram um tutorial separado, voltado à tarefa de adicionar uma pasta do Google Drive.

    O tutorial do Google Drive começa com um pedido:

    Mostre como adicionar uma pasta do Google Drive.

    Conecte o Google Drive

    O Codex verifica se o Google Drive está conectado. Se não estiver, o Codex destaca Conectar o Google Drive e pede ao usuário que selecione essa opção e conclua a conexão.

    O Codex destaca a opção Conectar o Google Drive no Runme e explica como começar.

    Abra o explorador de arquivos

    Após a conclusão da conexão, o Codex orienta o usuário até o explorador de arquivos. A próxima instrução acompanha o estado atualizado do aplicativo.

    O Codex destaca o controle que abre o explorador de arquivos do Runme.

    Adicione a pasta

    Depois que o usuário expande a barra de ferramentas, o Codex destaca o controle para adicionar uma pasta do Google Drive. O usuário mantém o controle da interação e aprende onde encontrar esse controle na próxima vez.

    O Codex destaca o controle para adicionar uma pasta do Google Drive no Runme.

    Dê ao Codex o contexto para orientar os usuários

    A implementação do Runme fornece três tipos de contexto: elementos-alvo do tutorial, estado do aplicativo e documentação. Os nomes das ferramentas abaixo são os usados pelo Runme; adapte essas mesmas funções ao seu aplicativo.

    Permita que os controles sejam encontrados

    Atribua valores estáveis e semânticos de data-tour-id aos elementos-alvo do tutorial, com um rótulo e uma descrição para cada um. O Runme expõe esses controles por meio de três ferramentas WebMCP:

    • listTargets lista os elementos-alvo registrados, seus IDs, rótulos e descrições.
    • showTourStep({ target, title?, message, placement? }) destaca um elemento-alvo e exibe uma explicação.
    • dismiss remove o destaque.

    Isso permite ao Codex identificar um controle e explicar sua função sem executar a ação pelo usuário.

    Leia o estado e aguarde o usuário

    O Runme mantém o estado relacionado ao tutorial fora do React e o expõe por meio de um controlador. Sua ferramenta getUiSnapshot fornece o estado atual da interface, incluindo o status de autenticação. waitForUiChange(...) permite que o Codex aguarde uma mudança, como quando o usuário seleciona o controle destacado.

    Peça ao Codex que leia o estado novamente após cada interação. O avanço do tutorial deve depender do que aconteceu no aplicativo, não de o Codex já ter exibido uma instrução.

    Mantenha as instruções junto ao aplicativo

    O Runme inclui documentação em Markdown no aplicativo e a disponibiliza por meio de WebMCP:

    • readInstructionsForAIAgents explica como o Codex deve interagir com o aplicativo e suas ferramentas.
    • listDocumentation() lista as páginas disponíveis e suas descrições.
    • getDocumentation({ name }) retorna uma página selecionada em Markdown.

    As instruções e as ferramentas do tutorial podem ser distribuídas com o aplicativo, sem um plug-in separado do Codex para o tutorial.

    Revise o tutorial

    Teste o mesmo pedido a partir de diferentes estados iniciais. Verifique se o tutorial pula as configurações já concluídas, aguarda o usuário e atualiza a orientação quando a interface muda.

    Teste também uma etapa cancelada e um controle que ainda não esteja visível. O Codex deve explicar o que falta ou escolher uma próxima etapa válida. Ele não deve afirmar que uma ação foi concluída com sucesso só porque destacou um botão.

    Mantenha a autenticação, as verificações de permissão e as ações do usuário no fluxo existente do aplicativo. O tutorial deve ajudar os usuários a entender a interface sem contornar esses controles.

    Sugestões para continuar

    Quando o primeiro fluxo estiver funcionando, continue no mesmo chat:

    • "Teste esta visita guiada quando o Google Drive já estiver conectado e o explorador de arquivos estiver fechado."
    • "Trate o caso em que um usuário cancela uma etapa e depois pede para continuar a visita guiada."
    • "Adicione uma visita guiada para [next workflow], reutilizando os alvos e as ferramentas de estado existentes."

    Casos de uso relacionados