Generar automáticamente documentación de API desde Linear
Crea un playbook de documentación, sincronízalo como una etiqueta de Linear y permite que cualquier persona de tu equipo active la generación de documentación etiquetando un ticket.Crea un playbook de documentación
Comienza creando un playbook para la tarea que quieres estandarizar. En este ejemplo, crearemos un playbook que genera documentación de API cada vez que un miembro del equipo etiqueta un ticket.Ve a Settings > Playbooks y haz clic en Create playbook. Asígnale un nombre y una macro (por ejemplo,
!add-docs).Escribe instrucciones específicas y paso a paso. Haz referencia a rutas de archivos y convenciones reales para que Devin siga los estándares de tu equipo:Cuanto más específico sea tu playbook, mejor será el resultado. Haz referencia a las plantillas de documentación reales de tu equipo, sus guías de estilo y sus herramientas. Consulta la documentación de playbooks para más información sobre cómo escribir playbooks efectivos.Sincronizar el playbook con Linear
Conecta tu integración con Linear si aún no lo has hecho: ve a Settings > Integrations > Linear y haz clic en Connect. Selecciona los equipos a los que Devin debe tener acceso.Una vez conectado, desplázate hasta Synced playbook labels y haz clic en Add playbook. Selecciona
!add-docs en el menú desplegable. Esto crea automáticamente una etiqueta llamada !add-docs en Linear dentro del grupo de etiquetas Devin Playbooks.Ahora, cuando alguien agregue esa etiqueta a un ticket, Devin inicia una sesión usando tu playbook.Para que las etiquetas de playbook se sincronicen automáticamente con Linear, tu espacio de trabajo de Linear debe tener Manage workspace labels configurado en All members (se encuentra en Settings > Security de Linear). Si eso no está habilitado, tendrás que crear las etiquetas manualmente en Linear.
Etiquetar incidencias y generar documentación
Cuando un miembro del equipo agrega la etiqueta
!add-docs a un ticket como este:ENG-215: Add POST /api/v2/webhooks endpoint — accepts a URL and event types, validates the URL is reachable, stores the subscription, and returns the webhook ID.Devin inicia automáticamente una sesión y sigue tu playbook de documentación:
- Lee el ticket — extrae la descripción del endpoint, los parámetros y cualquier PR vinculado
- Encuentra el código fuente — localiza el controlador de ruta, el esquema de validación de la solicitud y los tipos de respuesta
- Genera la documentación — crea una nueva página en
docs/api/siguiendo tu formato existente - Abre un PR — incluye la nueva página de documentación y la barra lateral actualizada
!add-docs para generar documentación para múltiples endpoints en paralelo.Crea más playbooks para tu equipo
El mismo patrón funciona para cualquier tarea recurrente. Crea un playbook, sincronízalo como una etiqueta y tu equipo podrá activarlo desde cualquier ticket. Aquí tienes algunas ideas:
!write-tests— Añade cobertura de pruebas para la funcionalidad descrita en un ticket!refactor— Refactoriza el código siguiendo las convenciones de tu equipo!security-audit— Revisa el código en busca de vulnerabilidades de seguridad y abre un PR con las correcciones!migrate— Ejecuta una migración estandarizada (actualización de dependencias, aumento de versión de API)