> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Générer automatiquement la documentation d’API à partir de Linear

export const UseCaseHero = ({title, description, prompt, category, features, devinUrl, agent, intent, playbookId, type}) => {
  const encodedPrompt = encodeURIComponent(prompt || '');
  const tag = 'docs-use-case-gallery';
  const utm = 'utm_source=docs&utm_medium=use-case-gallery&utm_campaign=hero-cta';
  const agentParams = (agent ? '&agent=' + agent : '') + (intent ? '&intent=' + intent : '') + (playbookId ? '&playbookId=' + playbookId : '');
  const devinHref = type === 'schedule' ? 'https://app.devin.ai/settings/schedules/create?' + utm + agentParams + (prompt ? '&prompt=' + encodedPrompt : '') : type === 'review' ? 'https://app.devin.ai/review?' + utm : agent === 'ada' ? 'https://app.devin.ai/search?' + utm + '&noSubmit=true' + (prompt ? '&prompt=' + encodedPrompt : '') : devinUrl ? devinUrl.includes('?') ? devinUrl + '&' + utm + agentParams : devinUrl + '?' + utm + agentParams : prompt ? 'https://app.devin.ai/?tags=' + tag + '&' + utm + agentParams + '&prompt=' + encodedPrompt : 'https://app.devin.ai/?' + utm + agentParams;
  const buttonLabel = type === 'schedule' ? 'Schedule in Devin ↗' : type === 'review' ? 'Set Up Devin Review ↗' : agent === 'advanced' ? 'Try in Devin ↗' : agent === 'dana' ? 'Try in Dana ↗' : agent === 'ada' ? 'Try in Ask Devin ↗' : 'Try in Devin ↗';
  const featureList = features ? features.split(',').map(f => f.trim()) : [];
  return <div className="uc-hero">
      <div className="uc-hero-inner">
        <div className="uc-hero-left">
          <h1 className="uc-hero-title">{title}</h1>
          <p className="uc-hero-desc">{description}</p>
          <div>
            <a href={devinHref} target="_blank" rel="noopener noreferrer" className="try-in-devin-btn">
              {buttonLabel}
            </a>
          </div>
        </div>
        <div className="uc-hero-meta">
          <div className="uc-meta-item">
            <span className="uc-meta-label">Author</span>
            <span className="uc-meta-value">Cognition</span>
          </div>
          <div className="uc-meta-item">
            <span className="uc-meta-label">Category</span>
            <span className="uc-meta-value">{category}</span>
          </div>
          {featureList.length > 0 && <div className="uc-meta-item">
              <span className="uc-meta-label">Features</span>
              <span className="uc-meta-value">{featureList.join(', ')}</span>
            </div>}
        </div>
      </div>
    </div>;
};

export const PromptBlock = ({children, type, agent, intent, playbookId}) => {
  var utm = 'utm_source=docs&utm_medium=use-case-gallery&utm_campaign=prompt-block';
  var tag = 'docs-use-case-gallery';
  var agentParams = (agent ? '&agent=' + agent : '') + (intent ? '&intent=' + intent : '') + (playbookId ? '&playbookId=' + playbookId : '');
  var label = type === 'schedule' ? 'Schedule in Devin' : type === 'playbook' ? 'Create Playbook' : type === 'knowledge' ? 'Add to Knowledge' : agent === 'advanced' ? 'Try in Devin' : agent === 'dana' ? 'Try in Dana' : agent === 'ada' ? 'Try in Ask Devin' : 'Try in Devin';
  var buildUrl = function (text) {
    var encoded = encodeURIComponent(text);
    if (type === 'schedule') return 'https://app.devin.ai/settings/schedules/create?' + utm + agentParams + '&prompt=' + encoded;
    if (type === 'playbook') return 'https://app.devin.ai/settings/playbooks/create?' + utm + '&body=' + encoded;
    if (type === 'knowledge') return 'https://app.devin.ai/knowledge?' + utm + '&body=' + encoded;
    if (agent === 'ada') return 'https://app.devin.ai/search?' + utm + '&noSubmit=true&prompt=' + encoded;
    return 'https://app.devin.ai/?tags=' + tag + '&' + utm + agentParams + '&prompt=' + encoded;
  };
  const ref = React.useRef(null);
  const [href, setHref] = React.useState('#');
  React.useEffect(() => {
    if (!ref.current) return;
    var codeEl = ref.current.querySelector('pre code');
    if (codeEl) {
      var text = codeEl.textContent.trim();
      if (text) setHref(buildUrl(text));
    }
    var header = ref.current.querySelector('[data-component-part="code-block-header"]');
    if (header && !header.querySelector('.prompt-block-devin-link')) {
      var link = document.createElement('a');
      link.href = href;
      link.target = '_blank';
      link.rel = 'noopener noreferrer';
      link.className = 'prompt-block-devin-link';
      link.style.cssText = 'display:inline-flex;align-items:center;gap:6px;text-decoration:none;color:#fff;font-size:11px;font-weight:500;padding:4px 10px;border-radius:6px;white-space:nowrap;background:#317CFF;transition:background 0.2s;margin-left:8px;';
      link.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/><polyline points="15 3 21 3 21 9"/><line x1="10" y1="14" x2="21" y2="3"/></svg> ' + label;
      link.onmouseenter = function () {
        link.style.background = '#2968D9';
      };
      link.onmouseleave = function () {
        link.style.background = '#317CFF';
      };
      header.appendChild(link);
    }
    var existingLink = ref.current.querySelector('.prompt-block-devin-link');
    if (existingLink && href !== '#') existingLink.href = href;
  });
  return <div className="prompt-block" ref={ref}>{children}</div>;
};

<UseCaseHero title="Générer automatiquement la documentation d’API à partir de Linear" description="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." prompt="Créez un playbook appelé !add-docs qui génère la documentation d’API pour le point de terminaison décrit dans un ticket Linear, en suivant nos conventions de documentation." category="Gestion de projet" features="Intégrations, Playbooks" devinUrl="https://app.devin.ai/settings/connections/linear" />

<div className="uc-detail-wrapper">
  <Tip>Vous ne souhaitez pas effectuer cette configuration manuellement ? Collez un lien vers cette page dans une session Devin et demandez-lui de tout configurer pour vous.</Tip>

  <Steps>
    <Step title="Rédiger un playbook de documentation">
      Commencez par créer un [playbook](/fr/product-guides/creating-playbooks) 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**](https://app.devin.ai/settings/playbooks?utm_source=docs\&utm_medium=use-case-gallery) 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 :

      <PromptBlock type="playbook">
        ```txt !add-docs playbook theme={null}
        Read the Linear ticket for context on the feature or endpoint. Then:

        1. Find the relevant source code — route handlers, controllers,
           models, and type definitions
        2. Read our existing docs in docs/api/ to understand the format
           and conventions we use
        3. Generate documentation covering: endpoint URL, HTTP method,
           request/response schemas, authentication requirements, error
           codes, and a usage example with curl
        4. Add the new page to the docs sidebar in docs/sidebar.json
        5. If there are related endpoints, add cross-references
        6. Open a PR with the new documentation
        ```
      </PromptBlock>

      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](/fr/product-guides/creating-playbooks) pour en savoir plus sur la rédaction de playbooks efficaces.
    </Step>

    <Step title="Synchroniser le playbook avec Linear">
      Connectez votre [intégration Linear](/fr/integrations/linear) si ce n’est pas déjà fait : allez dans [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery) 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.

      <Note>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.</Note>
    </Step>

    <Step title="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

      Cela fonctionne aussi très bien pour les opérations par lot — sélectionnez plusieurs tickets avec **Cmd+A**, faites un clic droit et ajoutez le label `!add-docs` pour générer la documentation de plusieurs endpoints en parallèle.

      <Tip>Avec l'intégration Linear installée, Devin a nativement accès aux outils de Linear ; votre playbook peut donc indiquer à Devin de mettre à jour les labels ou le statut des tickets en fonction du résultat. Comme les labels peuvent déclencher d'autres automatisations, vous pouvez enchaîner les workflows — p. ex., après la génération de la documentation, un label `Docs Ready` pourrait avertir le rédacteur technique pour relecture.</Tip>
    </Step>

    <Step title="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)

      Vous pouvez également configurer des [déclencheurs d'automatisation](/fr/integrations/linear) afin que Devin commence à travailler sans que personne n'applique de libellé. Accédez à [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery), faites défiler jusqu'à **Automation triggers**, et configurez un déclencheur qui se lance lorsque des tickets passent à un statut ou un libellé spécifique.
    </Step>
  </Steps>
</div>
