Codex use case
Mantenha a documentação atualizada
Use o código e outras fontes para automatizar a atualização da documentação.
Use o Codex para comparar as mudanças no código-fonte com a documentação pública, as notas de versão e o contexto dos pull requests. Depois, prepare um rascunho das atualizações necessárias e inclua as etapas de verificação antes de publicar.
Best for
- Documentação para desenvolvedores, READMEs, guias operacionais, exemplos e notas de migração que precisam acompanhar mudanças frequentes no comportamento do produto.
- Equipes que mantêm a documentação de um produto técnico.
Contents
Mantenha a documentação atualizada
Use o código e outras fontes para automatizar a atualização da documentação.
Use o Codex para comparar as mudanças no código-fonte com a documentação pública, as notas de versão e o contexto dos pull requests. Depois, prepare um rascunho das atualizações necessárias e inclua as etapas de verificação antes de publicar.
Use o Codex para comparar as mudanças no código-fonte com a documentação pública, as notas de versão e o contexto dos pull requests. Depois, prepare um rascunho das atualizações necessárias e inclua as etapas de verificação antes de publicar.
Related links
Best for
- Documentação para desenvolvedores, READMEs, guias operacionais, exemplos e notas de migração que precisam acompanhar mudanças frequentes no comportamento do produto.
- Equipes que mantêm a documentação de um produto técnico.
Skills & Plugins
- Se sua equipe usa o GitHub para receber relatos de bugs, leia as issues, os pull requests, os comentários e as discussões de revisão. Consulte também as verificações que falharam.
| Skill | Why use it |
|---|---|
| GitHub | Se sua equipe usa o GitHub para receber relatos de bugs, leia as issues, os pull requests, os comentários e as discussões de revisão. Consulte também as verificações que falharam. |
Starter prompt
Introdução
É mais fácil manter a documentação em dia quando você a atualiza junto com o código, sem esperar semanas. O Codex pode analisar as alterações no código, os testes, as notas de versão, as issues vinculadas e o contexto do pull request. Com essas informações, ele pode redigir uma atualização que se limite ao que mudou e siga a estrutura atual da documentação.
Use esse fluxo de trabalho para escrever documentação para desenvolvedores, atualizar arquivos README, preparar rascunhos de registros de alterações, redigir notas de migração ou manter guias operacionais e outros materiais que precisem acompanhar mudanças frequentes de comportamento.
Como usar
-
Comece pela alteração que você precisa documentar.
Compartilhe a branch, o pull request, o commit, a issue ou os arquivos. Se a documentação for pública, deixe claro que ela deve omitir planos de desenvolvimento ainda não divulgados, informações privadas de clientes e informações de uso exclusivamente interno.
-
Peça ao Codex para identificar as partes da documentação afetadas.
Peça ao Codex que, antes de redigir a atualização, procure na documentação atual nomes de funcionalidades, chaves de configuração, comandos, exemplos e termos relacionados.
-
Atualize apenas o trecho necessário da documentação.
O Codex deve preservar a estrutura atual da página, a terminologia, os links entre páginas e o frontmatter. Se uma nota específica, um exemplo ou um ajuste em uma seção for suficiente, ele deve evitar reescrever trechos inteiros.
-
Verifique as alterações.
Peça ao Codex para executar as verificações de formatação e de documentação adequadas ao repositório. Em seguida, peça que resuma as evidências que sustentam cada afirmação feita aos usuários.
O que fornecer ao Codex
| Fonte | Como ajuda |
|---|---|
| Código e testes alterados | Permitem que o Codex analise o comportamento real e redija atualizações específicas para a documentação. |
| Notas de versão ou documentação do produto disponíveis publicamente | Ajudam o Codex a usar a terminologia pública e a descrever a disponibilidade e a situação das funcionalidades conforme o que já foi divulgado. |
| Contexto do pull request ou da issue | Explica o motivo da alteração e quais aspectos do comportamento são relevantes para os usuários. |
| Verificações locais da documentação | Dão ao Codex critérios concretos para saber quando a documentação está pronta para publicação. |
Fornecer mais contexto, como notas de versão públicas, ajuda o Codex a evitar a inclusão de informações privadas ou de atualizações que ainda não foram divulgadas.
Como reutilizar o fluxo de trabalho
Para definir uma convenção que valha para todo o repositório, inclua as orientações sobre documentação no arquivo AGENTS.md. Por exemplo:
## Documentation
- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.Se o processo tiver mais etapas, transforme-o em uma habilidade. Assim, em tarefas futuras, o Codex poderá seguir as mesmas etapas de consulta às fontes, redação e verificação. Para saber mais sobre essa prática, consulte Salve fluxos de trabalho como habilidades.
Você também pode agendar uma tarefa para esse fluxo de trabalho no chat atual. Por exemplo, peça ao Codex para buscar os pull requests recentes no GitHub e atualizar a documentação toda semana:
Related use cases
Crie jogos de navegador
Use o Codex para transformar a descrição do jogo em um plano bem definido e, em seguida, em...
Crie uma CLI que o Codex possa usar
Peça ao Codex que crie uma CLI que ele possa executar de qualquer pasta, combinar com...
Investigue um incidente e teste uma correção
Forneça ao Codex Cloud um dossiê do incidente sem dados sensíveis e um ambiente de teste...