30 minutes
How to Manter a documentação atualizada with Eigent
Use alterações de código e contexto de PR para redigir atualizações de documentação focadas — sem reescritas amplas ou referências desatualizadas.
What you need
- Aplicativo desktop do Eigent
- Acesso à base de código (repositório local ou conectado)
- Repositório de documentação ou sistema de documentação conectado
Best for
- Documentação para desenvolvedores, READMEs, runbooks e notas de migração que acompanham uma base de código em rápida evolução
- Equipes que mantêm a documentação junto com mudanças frequentes de código
- Engenheiros escrevendo notas de release ou changelogs a partir de PRs mesclados
Starter Prompt
Atualize a documentação de [produto/recurso] com base nas seguintes fontes: - os arquivos de origem alterados em [este repositório / repositório vinculado] - as páginas de documentação existentes que mencionam o comportamento alterado - qualquer issue vinculada, PR, nota de release ou referência pública que eu fornecer abaixo Em seguida: - identifique o que é visível para o usuário - atualize apenas a documentação que precisa mudar - mantenha fora da documentação pública o roadmap não publicado, detalhes privados de clientes e contexto interno - preserve a estrutura existente da documentação, a terminologia e os cross-links - execute as verificações de documentação adequadas à mudança Antes de finalizar, resuma o que mudou, o que foi verificado e quaisquer afirmações que você não conseguiu provar a partir de fontes confiáveis.
Como funciona
- Compartilhe os arquivos de origem alterados, a branch, o pull request ou o commit que precisa ser documentado.
- Peça ao Eigent para pesquisar a documentação existente pelos nomes de recursos, chaves de configuração, comandos e exemplos afetados.
- Atualize apenas a documentação que precisa mudar — preserve a estrutura da página, a terminologia, os cross-links e o frontmatter.
- Execute a formatação e as verificações de documentação, depois peça ao Eigent para resumir as evidências por trás de cada afirmação visível para o usuário.
- Revise o resumo antes de publicar para confirmar que nenhum contexto interno ou não publicado vazou para a documentação pública.
Mais prompts para testar
- Quais páginas de documentação existentes fazem referência ao comportamento alterado neste PR?
- Esta mudança afeta algum parâmetro de API pública, valor padrão ou flag de CLI que precise ser atualizado?
- Escreva uma entrada de changelog para este release que corresponda ao nosso formato atual.
- Identifique quaisquer afirmações visíveis para o usuário na documentação atualizada que você não consiga verificar apenas pelo código-fonte.
Como usar
Comece pela mudança que você precisa documentar — compartilhe a branch, o PR ou o commit. Peça ao Eigent para pesquisar a documentação existente antes de redigir qualquer coisa, para que ele atualize as páginas certas em vez de escrever novas páginas que duplicam conteúdo existente. Mantenha o escopo restrito: uma nota precisa ou uma atualização de exemplo é melhor do que uma reescrita completa da página. Para tornar isso repetível, salve o workflow como uma skill ou peça ao Eigent para executá-lo em uma agenda após cada release.
Saída esperada
Arquivos de documentação atualizados cobrindo apenas as mudanças visíveis para o usuário, um resumo do que foi alterado e verificado, e uma lista de quaisquer afirmações que não puderam ser confirmadas por fontes confiáveis e exigem revisão humana.
Limitações
- O Eigent não pode acessar dados privados de clientes, itens de roadmap não publicados ou wikis internas, a menos que você os forneça explicitamente.
- A precisão da documentação depende da qualidade dos comentários de origem e da cobertura de testes — comportamentos não documentados podem ser perdidos.
- Sites de documentação muito grandes se beneficiam de limitar a busca a uma seção ou área de recurso específica, em vez de ao site inteiro.
Related workflows
Salve Workflows como Skills
Transforme uma thread funcional do Eigent, regras de revisão, comandos de teste ou checklists de rel…
Revisar Pull Requests do GitHub
Detecte regressões, testes ausentes e mudanças de comportamento arriscadas antes da revisão humana —…
Refatore Sua Base de Código
Remova código morto e modernize padrões legados sem बदलamento de comportamento — em pequenas etapas …
