Visão geral
Para repositórios públicos
A experiência completa do Ask Devin, incluindo pesquisa avançada de código, planejamento e criação de sessões, está disponível no aplicativo Devin. O DeepWiki público e o DeepWiki MCP fornecem recursos básicos de documentação e perguntas e respostas.
Níveis de esforço e custo
As orgs Enterprise sempre usam o nível de esforço baixo; essa configuração não pode ser alterada para elas.
Orientando o DeepWiki

.devin/wiki.json permite orientar o comportamento padrão de geração de wiki do Devin, o que é especialmente importante para repositórios grandes que podem atingir limites embutidos.
Se um arquivo .devin/wiki.json for encontrado no diretório raiz do seu repositório durante a geração da wiki, usaremos os repo_notes e pages fornecidos para orientar a geração da wiki. Ambos os campos são obrigatórios, e pages deve listar pelo menos uma página. Quando há um arquivo de configuração presente, ignoramos o planejamento padrão baseado em clusters e criamos exatamente as páginas que você especificar — portanto, liste todas as páginas que você quiser. Isso garante que as partes importantes da sua base de código sejam documentadas mesmo quando o sistema automático normalmente as ignoraria.
Formato de configuração
.devin/wiki.json na raiz do repositório com a seguinte estrutura:
Opções de configuração
repo_notes (Array, obrigatório)
repo_notes mesmo que não tenha notas a adicionar — use um array vazio ([]).
- content (string, obrigatório): Conteúdo da nota (máximo de 10.000 caracteres)
- author (string, opcional): Autor da nota
pages (Array, obrigatório)
.devin/wiki.json que omite pages (ou o deixa vazio) é rejeitado, então liste todas as páginas que você deseja criar.
- title (string, obrigatório): O título da página (deve ser único e não vazio)
- purpose (string, obrigatório): O que esta página deve documentar
- parent (string, opcional): Título da página principal para organização hierárquica
- page_notes (array, opcional): Anotações adicionais específicas desta página
Limites de validação
- No máximo 30 páginas (80 para Enterprise)
- No máximo 100 notas no total (repo_notes + todas as page_notes combinadas)
- No máximo 10.000 caracteres por nota
- Os títulos de página devem ser únicos e não podem estar em branco
Exemplos práticos
Exemplo 1: Use Repo Notes para enfatizar prioridades
repo_notes para indicar ao Devin o que enfatizar e liste as pages que você deseja junto com elas. As notas orientam como cada página é escrita; pages determina quais páginas são criadas.
Exemplo 2: Garantindo a documentação de pastas específicas
repo_notes para explicar por que elas são importantes:
Exemplo 3: Abordando Componentes Ausentes
repo_notes:
Exemplo 4: Estrutura de Documentação Hierárquica
Boas práticas
1. Use Repo Notes de forma estratégica
- Forneça contexto sobre quais partes do seu codebase são mais importantes
- Mencione diretórios ou componentes específicos que devem ser priorizados
- Explique as relações entre diferentes partes do seu sistema
2. Organize as páginas de forma lógica
- Comece com páginas de visão geral de alto nível
- Use relações pai-filho para criar hierarquias claras
- Agrupe funcionalidades relacionadas
3. Seja específico sobre o objetivo de cada página
- Declare claramente o que cada página deve documentar
- Mencione diretórios, arquivos ou conceitos específicos em que a página deve focar
- Forneça detalhes suficientes para o sistema entender sua intenção
4. Aborde Lacunas Conhecidas
- Se você sabe que certas partes da sua base de código estão ficando de fora, inclua-as explicitamente
- Use títulos descritivos que deixem claro o que deve ser abrangido
Solução de problemas comuns
”Apenas algumas pastas estão sendo documentadas”
.devin/wiki.json para especificar explicitamente quais partes da sua base de código devem ser documentadas.
”Componentes importantes estão ausentes na wiki”
Primeiros passos
- Crie
.devin/wiki.jsonna raiz do seu repositório - Adicione
repo_notesexplicando a estrutura da sua base de código e suas prioridades - Especifique todas as páginas que você quer criar, com títulos e objetivos claros (pelo menos uma página é obrigatória)
- Faça o commit do arquivo e regenere sua wiki

