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
Theme
Codex

Codex use case

Entenda grandes bases de código

Acompanhe o fluxo das requisições, mapeie módulos que você ainda não conhece e encontre rapidamente os arquivos certos.

Difficulty Easy
Time horizon 5m

Use o Codex para mapear bases de código que você ainda não conhece. Peça que ele explique o papel dos módulos e o fluxo de dados e indique quais arquivos vale a pena ler antes de alterar o código.

Best for

  • Profissionais de engenharia que estão começando a trabalhar em um novo repositório ou serviço
  • Quem quer entender como um recurso funciona antes de alterá-lo

Contents

    ← All use cases

    Entenda grandes bases de código

    Acompanhe o fluxo das requisições, mapeie módulos que você ainda não conhece e encontre rapidamente os arquivos certos.

    Use o Codex para mapear bases de código que você ainda não conhece. Peça que ele explique o papel dos módulos e o fluxo de dados e indique quais arquivos vale a pena ler antes de alterar o código.

    Easy
    5m

    Use o Codex para mapear bases de código que você ainda não conhece. Peça que ele explique o papel dos módulos e o fluxo de dados e indique quais arquivos vale a pena ler antes de alterar o código.

    Easy
    5m

    Best for

    • Profissionais de engenharia que estão começando a trabalhar em um novo repositório ou serviço
    • Quem quer entender como um recurso funciona antes de alterá-lo

    Starter prompt

    Explique o caminho que a requisição percorre no código de <name of the system area>. Inclua: - o papel de cada módulo - onde os dados são validados - as principais armadilhas que devo conhecer antes de alterar o código Por fim, indique quais arquivos devo ler em seguida.
    Explique o caminho que a requisição percorre no código de <name of the system area>. Inclua: - o papel de cada módulo - onde os dados são validados - as principais armadilhas que devo conhecer antes de alterar o código Por fim, indique quais arquivos devo ler em seguida.

    Introdução

    Quando você começa a trabalhar em um repositório ou assume uma funcionalidade que ainda não conhece, o Codex pode ajudar você a se situar antes de alterar o código. O objetivo vai além de obter uma visão geral. Você pode mapear o caminho que uma requisição percorre, entender as responsabilidades de cada módulo e identificar quais arquivos vale a pena ler em seguida.

    Como usar

    Se você está começando em um projeto, peça ao Codex que explique a base de código como um todo.

    Explique como este repositório funciona

    Se você precisa implementar uma nova funcionalidade em uma base de código existente, peça ao Codex que explique uma parte específica do sistema. Quanto melhor você delimitar o pedido, mais concreta será a explicação.

    1. Indique ao Codex os arquivos, os diretórios ou a área funcional que você quer entender.
    2. Peça que acompanhe o caminho de uma requisição e explique quais módulos cuidam da lógica de negócio, do transporte, da persistência ou da interface do usuário.
    3. Antes de editar qualquer coisa, pergunte onde ocorrem a validação, os efeitos colaterais ou as transições de estado.
    4. Por fim, pergunte quais arquivos você deve ler em seguida e quais pontos exigem mais cuidado.

    Uma boa resposta para quem está começando vai além de listar nomes de arquivos. Ela deve mostrar como as partes do sistema se conectam. Ao final, o Codex deve ter explicado o fluxo principal, destacado os pontos de risco e indicado quais arquivos ler ou quais verificações fazer antes de começar a editar.

    Perguntas para aprofundar a análise

    Depois da primeira explicação do Codex, continue fazendo perguntas até ter detalhes suficientes para fazer a primeira alteração com confiança. Boas perguntas de acompanhamento costumam levar o Codex a explicitar premissas, identificar dependências ocultas e apontar as verificações importantes após uma alteração.

    • Qual módulo implementa a lógica de negócio e quais cuidam do transporte ou da interface do usuário?
    • Onde ocorre a validação e quais premissas ela garante que sejam atendidas?
    • Que arquivos relacionados ou tarefas em segundo plano podem passar despercebidos se eu alterar esse fluxo?
    • Quais testes ou verificações devo executar depois de editar essa parte do código?

    Related use cases