Générer automatiquement la documentation d’API à partir de Linear
Créez un playbook de documentation, synchronisez-le en tant que libellé Linear, et laissez n’importe qui dans votre équipe déclencher la génération de documentation en appliquant ce libellé à un ticket.Rédiger un playbook de documentation
Commencez par créer un playbook pour la tâche que vous souhaitez standardiser. Dans cet exemple, nous allons créer un playbook qui génère la documentation d’API chaque fois qu’un membre de l’équipe ajoute un libellé à un ticket.Accédez à Settings > Playbooks et cliquez sur Create playbook. Donnez-lui un nom et une macro (par exemple,
!add-docs).Rédigez des instructions précises et détaillées, étape par étape. Utilisez de vrais chemins de fichiers et les conventions existantes afin que Devin respecte les standards de votre équipe :Plus votre playbook est spécifique, meilleur sera le résultat. Appuyez-vous sur les modèles de documentation, guides de style et outils réellement utilisés par votre équipe. Consultez la documentation sur les playbooks pour en savoir plus sur la rédaction de playbooks efficaces.Synchroniser le playbook vers Linear
Connectez votre intégration Linear si ce n’est pas déjà fait : allez dans Settings > Integrations > Linear et cliquez sur Connect. Sélectionnez les équipes auxquelles Devin doit avoir accès.Une fois la connexion établie, faites défiler la page jusqu’à Synced playbook labels et cliquez sur Add playbook. Sélectionnez
!add-docs dans la liste déroulante. Cela crée automatiquement un libellé appelé !add-docs dans Linear, dans le groupe de libellés Devin Playbooks.Désormais, lorsqu’un utilisateur ajoute ce libellé à un ticket, Devin démarre une session en utilisant votre playbook.Pour que les libellés de playbook soient synchronisés automatiquement avec Linear, votre espace de travail Linear doit avoir Manage workspace labels défini sur All members (dans les Settings > Security de Linear). Si ce n’est pas activé, vous devrez créer les libellés manuellement dans Linear.
Ajoutez des étiquettes aux tickets et générez la documentation
Lorsqu’un membre de l’équipe ajoute le label
!add-docs à un ticket comme celui-ci :ENG-215 : Ajouter l’endpoint POST /api/v2/webhooks — accepte une URL et des types d’événements, vérifie que l’URL est accessible, enregistre l’abonnement et renvoie l’ID du webhook.Devin démarre automatiquement une session et suit votre playbook de documentation :
- Lit le ticket — extrait la description de l’endpoint, les paramètres et toutes les PR liées
- Trouve le code source — repère le gestionnaire de route, le schéma de validation de requête et les types de réponse
- Génère la documentation — crée une nouvelle page dans
docs/api/en suivant votre format existant - Ouvre une PR — inclut la nouvelle page de documentation et la sidebar mise à jour
!add-docs pour générer la documentation de plusieurs endpoints en parallèle.Créez davantage de playbooks pour votre équipe
Le même principe fonctionne pour toute tâche récurrente. Créez un playbook, synchronisez-le comme libellé, et votre équipe pourra le déclencher depuis n’importe quel ticket. Voici quelques idées :
!write-tests— Ajouter une couverture de test pour la fonctionnalité décrite dans un ticket!refactor— Refactoriser le code en suivant les conventions de votre équipe!security-audit— Examiner le code pour détecter des vulnérabilités de sécurité et ouvrir une PR avec les correctifs!migrate— Exécuter une migration standardisée (mise à niveau de dépendances, montée de version d’API)