Genera automaticamente la documentazione API da Linear
Crea un playbook per la documentazione, sincronizzalo come etichetta in Linear e consenti a chiunque nel tuo team di avviare la generazione della documentazione etichettando un ticket.Scrivi un playbook per la documentazione
Inizia creando un playbook per l’attività che vuoi standardizzare. In questo esempio creeremo un playbook che genera la documentazione delle API ogni volta che un membro del team applica un’etichetta a un ticket.Vai su Settings > Playbooks e fai clic su Create playbook. Assegnagli un nome e una macro (ad es.
!add-docs).Scrivi istruzioni specifiche e dettagliate, passo per passo. Fai riferimento a percorsi di file reali e alle convenzioni, in modo che Devin segua gli standard del tuo team:Più il tuo playbook è specifico, migliore sarà il risultato. Fai riferimento ai template di documentazione effettivi del tuo team, alle guide di stile e agli strumenti che utilizzate. Consulta la documentazione sui playbook per maggiori informazioni sulla scrittura di playbook efficaci.Sincronizza il playbook su Linear
Collega la tua integrazione Linear se non l’hai già fatto: vai su Settings > Integrations > Linear e fai clic su Connect. Seleziona i team a cui Devin deve avere accesso.Una volta collegata l’integrazione, scorri fino a Synced playbook labels e fai clic su Add playbook. Seleziona
!add-docs dal menu a discesa. Questo crea automaticamente un’etichetta chiamata !add-docs in Linear, all’interno del gruppo di etichette Devin Playbooks.Ora, quando qualcuno aggiunge quell’etichetta a un ticket, Devin avvia una sessione utilizzando il tuo playbook.Affinché le etichette dei playbook vengano sincronizzate automaticamente con Linear, il tuo workspace di Linear deve avere Manage workspace labels impostato su All members (lo trovi in Settings > Security di Linear). Se questa opzione non è abilitata, dovrai creare manualmente le etichette in Linear.
Applica etichette ai ticket e genera documentazione
Quando un membro del team aggiunge l’etichetta
!add-docs a un ticket come questo:ENG-215: Aggiungi endpoint POST /api/v2/webhooks — accetta un URL e tipi di evento, verifica che l’URL sia raggiungibile, registra la sottoscrizione e restituisce l’ID del webhook.Devin avvia automaticamente una sessione e segue il tuo playbook per la documentazione:
- Legge il ticket — estrae la descrizione dell’endpoint, i parametri e qualsiasi pull request (PR) collegata
- Trova il codice sorgente — individua l’handler della route, lo schema di validazione della richiesta e i tipi di risposta
- Genera la documentazione — crea una nuova pagina in
docs/api/seguendo il tuo formato esistente - Apre una PR — include la nuova pagina di documentazione e la sidebar aggiornata
!add-docs per generare la documentazione di più endpoint in parallelo.Crea altri playbook per il tuo team
Lo stesso modello funziona per qualsiasi attività ricorrente. Crea un playbook, sincronizzalo come etichetta e il tuo team potrà attivarlo da qualsiasi ticket. Ecco alcune idee:
!write-tests— Aggiungi copertura di test per la funzionalità descritta in un ticket!refactor— Effettua il refactoring del codice seguendo le convenzioni del tuo team!security-audit— Esamina il codice per individuare vulnerabilità di sicurezza e apri una PR con le correzioni!migrate— Esegui una migrazione standardizzata (aggiornamento delle dipendenze, aggiornamento della versione dell’API)