Skip to main content

Panoramica

Devin ora indicizza automaticamente i tuoi repository e produce wiki con diagrammi dell’architettura, collegamenti alle fonti e riepiloghi della tua codebase. Usalo per orientarti rapidamente nelle parti della tua codebase che conosci meno: dagli un’occhiata nella tua barra laterale. Ask Devin utilizzerà le informazioni presenti nel Wiki per comprendere meglio e trovare il contesto pertinente nella tua codebase. Le funzionalità avanzate di ricerca del codice di Ask Devin, combinate con DeepWiki, producono risposte dettagliate e accurate basate sul tuo codice.
DeepWiki verrà generato automaticamente quando colleghi i repository durante l’onboarding.

Per i repository pubblici

È ora disponibile una versione gratuita di DeepWiki e Ask Devin che funziona con i repository GitHub pubblici. Genera automaticamente diagrammi dell’architettura, documentazione e collegamenti al codice sorgente per aiutarti a comprendere rapidamente codebase che non conosci. Puoi anche porre domande complesse sulla codebase per ottenere risposte specifiche basate sul contesto.
L’esperienza completa di Ask Devin, inclusa la ricerca avanzata nel codice, la pianificazione e la creazione di sessioni, è disponibile nell’app Devin. La versione pubblica di DeepWiki e il DeepWiki MCP forniscono funzionalità di documentazione e di domande e risposte di base.
Visita deepwiki.com per iniziare a esplorare popolari repository open source come React, TensorFlow, LangChain e molti altri. Puoi anche inserire l’URL del tuo repository GitHub pubblico per l’indicizzazione. Prova DeepWiki ora →

Livelli di impegno e costi

La generazione di wiki viene eseguita con uno dei tre livelli di impegno, configurabili per org (e modificabili per repo) dalla pagina della wiki:
Le wiki con livello di impegno medio o alto vengono addebitate sull’utilizzo di ACU del tuo team e richiedono quindi un abbonamento attivo o un saldo crediti positivo. Se il tuo team non dispone di nessuno dei due, la generazione viene rifiutata e non viene prodotta alcuna wiki — aggiungi crediti o passa al livello di impegno basso.
Le org Enterprise vengono sempre eseguite con un livello di impegno basso; questa impostazione non è configurabile.

Gestire DeepWiki

Steerable Wiki UI
Il file .devin/wiki.json ti consente di controllare il comportamento predefinito di generazione della wiki di Devin, il che è particolarmente importante per i repository di grandi dimensioni che potrebbero raggiungere i limiti predefiniti. Se durante la generazione della wiki viene trovato un file .devin/wiki.json nella directory radice del tuo repository, utilizzeremo i repo_notes e pages forniti per orientare la generazione della wiki. Entrambi i campi sono obbligatori e pages deve elencare almeno una pagina. Quando è presente un file di configurazione, salteremo la pianificazione predefinita basata sui cluster e creeremo esattamente le pagine che specifichi, quindi elenca tutte le pagine che desideri. Questo garantisce che le parti importanti della tua codebase vengano documentate anche quando il sistema automatico altrimenti le ignorerebbe.

Formato di configurazione

Crea un file .devin/wiki.json nella directory principale del repository con la seguente struttura:

Opzioni di configurazione

repo_notes (Array, required)

Fornisce contesto e indicazioni per aiutare il sistema di documentazione a comprendere meglio il repository. Includi la chiave repo_notes anche se non hai note da aggiungere: usa un array vuoto ([]).
  • content (string, required): il contenuto della nota (fino a 10.000 caratteri)
  • author (string, optional): chi ha scritto la nota

pages (Array, obbligatorio)

Specifica esattamente quali pagine devono essere create nella tua wiki. Questo campo è obbligatorio e deve contenere almeno una pagina. Le pagine vengono trattate come istruzioni esplicite: verranno generate solo le pagine che definisci nel JSON, né più né meno. Un .devin/wiki.json che omette pages (o lo lascia vuoto) viene rifiutato, quindi elenca ogni pagina che vuoi creare.
  • title (string, obbligatorio): Il titolo della pagina (deve essere univoco e non vuoto)
  • purpose (string, obbligatorio): Cosa deve documentare questa pagina
  • parent (string, facoltativo): Titolo della pagina padre per l’organizzazione gerarchica
  • page_notes (array, facoltativo): Note aggiuntive specifiche per questa pagina

Limiti di convalida

  • Massimo 30 pagine (80 per i clienti enterprise)
  • Massimo 100 note complessive (repo_notes + tutte le page_notes combinate)
  • Massimo 10.000 caratteri per nota
  • I titoli delle pagine devono essere univoci e non vuoti

Esempi pratici

Esempio 1: usare le Repo Notes per evidenziare le priorità

Usa repo_notes per indicare a Devin cosa mettere in risalto ed elenca accanto le pages che desideri. Le note guidano come viene scritta ciascuna pagina; pages determina quali pagine vengono create.

Esempio 2: Assicurarsi che cartelle specifiche siano documentate

Se il tuo repository di grandi dimensioni contiene cartelle importanti che non vengono incluse nella wiki, aggiungi una pagina per ciascuna e usa repo_notes per spiegare perché sono importanti:

Esempio 3: Gestione dei componenti mancanti

Se noti che alcune parti della tua codebase non vengono documentate, aggiungi una pagina per ciascuna ed evidenziale in repo_notes:

Esempio 4: Struttura gerarchica della documentazione

Per i repository complessi, organizza le pagine in modo gerarchico:

Best practice consigliate

1. Usa le Repo Notes in modo strategico

  • Fornisci contesto su quali parti della tua codebase sono più importanti
  • Indica cartelle o componenti specifici a cui dare priorità
  • Spiega le relazioni tra le diverse parti del tuo sistema

2. Organizza le pagine in modo logico

  • Inizia con pagine di panoramica ad alto livello
  • Usa relazioni padre-figlio per creare gerarchie chiare
  • Raggruppa le funzionalità correlate

3. Sii specifico negli obiettivi di ogni pagina

  • Indica chiaramente cosa dovrebbe documentare ciascuna pagina
  • Specifica le directory, i file o i concetti su cui concentrarsi
  • Fornisci dettagli sufficienti affinché il sistema comprenda le tue intenzioni

4. Colma le lacune note

  • Se sai che alcune parti della tua codebase vengono escluse, includile esplicitamente
  • Usa titoli descrittivi che rendano chiaro cosa deve essere trattato

Risoluzione dei problemi più comuni

”Solo alcune cartelle vengono documentate”

Questo è il classico problema dei repository di grandi dimensioni. Soluzione: Usa .devin/wiki.json per specificare in modo esplicito quali parti della tua codebase devono essere documentate.
Aggiungi una pagina all’array pages per ogni cartella che vuoi includere e usa repo_notes per spiegare perché è importante. La wiki genera solo le pagine che elenchi, quindi qualsiasi cartella senza una pagina non comparirà.

”Mancano componenti importanti nella wiki”

Aggiungi pagine specifiche per questi componenti e usa repo_notes per evidenziarne l’importanza.
Ricorda: DeepWiki genererà solo le pagine incluse in questo array, quindi assicurati che siano presenti tutte le pagine, non solo quella mancante.

Per iniziare

  1. Crea .devin/wiki.json nella directory principale del tuo repository
  2. Aggiungi repo_notes che spieghino la struttura della tua codebase e le priorità
  3. Specifica tutte le pagine che vuoi vengano create, con titoli e obiettivi chiari (è richiesta almeno una pagina)
  4. Esegui il commit del file e rigenera la tua wiki
Il sistema ora creerà la documentazione in base alle tue istruzioni esplicite, anziché tramite analisi completamente automatica, garantendo una copertura più completa e accurata dei repository di grandi dimensioni.