Gerar automaticamente documentação de API a partir do Linear
Crie um playbook de documentação, sincronize-o como uma etiqueta no Linear e permita que qualquer pessoa da sua equipe acione a geração de documentação ao etiquetar um ticket.Crie um playbook de documentação
Comece criando um playbook para a tarefa que você deseja padronizar. Neste exemplo, vamos criar um playbook que gera documentação de API sempre que um membro do time marca um ticket com um rótulo.Vá para Settings > Playbooks e clique em Create playbook. Dê a ele um nome e uma macro (por exemplo,
!add-docs).Escreva instruções específicas, passo a passo. Use caminhos de arquivos reais e convenções que permitam que o Devin siga os padrões do seu time:Quanto mais específico for o seu playbook, melhor será o resultado. Use os modelos de documentação reais do seu time, guias de estilo e ferramentas. Consulte a documentação de playbooks para saber mais sobre como escrever playbooks eficazes.Sincronize o playbook com o Linear
Conecte sua integração com o Linear, se ainda não tiver feito isso: vá para Settings > Integrations > Linear e clique em Connect. Selecione as equipes às quais o Devin deve ter acesso.Depois de conectar, role até Synced playbook labels e clique em Add playbook. Selecione
!add-docs no menu suspenso. Isso cria automaticamente um rótulo chamado !add-docs no Linear, no grupo de rótulos Devin Playbooks.Agora, quando alguém adicionar esse rótulo a um ticket, o Devin iniciará uma sessão usando seu playbook.Para que os rótulos de playbook sejam sincronizados automaticamente com o Linear, seu workspace do Linear deve ter Manage workspace labels definido como All members (em Settings > Security do Linear). Se isso não estiver habilitado, você precisará criar os rótulos manualmente no Linear.
Rotular tickets e gerar documentação
Quando um membro da equipe adiciona o rótulo
!add-docs a um ticket como este:ENG-215: Adicionar endpoint POST /api/v2/webhooks — aceita uma URL e tipos de evento, verifica se a URL é acessível, armazena a assinatura e retorna o ID do webhook.Devin inicia automaticamente uma sessão e segue o seu playbook de documentação:
- Lê o ticket — extrai a descrição do endpoint, parâmetros e quaisquer PRs vinculados
- Encontra o código-fonte — localiza o handler de rota, o esquema de validação da requisição e os tipos de resposta
- Gera a documentação — cria uma nova página em
docs/api/seguindo o seu formato existente - Abre um PR — inclui a nova página de documentação e a sidebar atualizada
!add-docs para gerar documentação para múltiplos endpoints em paralelo.Crie mais playbooks para o seu time
O mesmo padrão funciona para qualquer tarefa recorrente. Crie um playbook, sincronize-o como um rótulo e sua equipe poderá acioná-lo a partir de qualquer ticket. Aqui vão algumas ideias:
!write-tests— Adicionar cobertura de testes para a funcionalidade descrita em um ticket!refactor— Refatorar o código seguindo as convenções da sua equipe!security-audit— Revisar o código em busca de vulnerabilidades de segurança e abrir um PR com as correções!migrate— Executar uma migração padronizada (atualização de dependências, atualização de versão da API)