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

# API-Dokumentation automatisch aus Linear erstellen

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="API-Dokumentation automatisch aus Linear generieren" description="Erstellen Sie ein Dokumentations-Playbook, synchronisieren Sie es als Linear-Label und ermöglichen Sie allen in Ihrem Team, die Generierung der Dokumentation auszulösen, indem sie ein Ticket labeln." prompt="Erstellen Sie ein Playbook mit dem Namen !add-docs, das API-Dokumentation für den in einem Linear-Ticket beschriebenen Endpoint generiert und dabei unsere Dokumentationsrichtlinien befolgt." category="Projektmanagement" features="Integrationen, Playbooks" devinUrl="https://app.devin.ai/settings/connections/linear" />

<div className="uc-detail-wrapper">
  <Tip>Möchten Sie das nicht manuell einrichten? Fügen Sie einen Link zu dieser Seite in eine Devin-Sitzung ein und bitten Sie Devin, alles für Sie einzurichten.</Tip>

  <Steps>
    <Step title="Erstellen Sie ein Playbook für die Dokumentation">
      Beginnen Sie damit, ein [Playbook](/de/product-guides/creating-playbooks) für die Aufgabe zu erstellen, die Sie standardisieren möchten. In diesem Beispiel erstellen wir ein Playbook, das API-Dokumentation generiert, sobald ein Teammitglied ein Ticket mit einem Label kennzeichnet.

      Gehen Sie zu [**Settings > Playbooks**](https://app.devin.ai/settings/playbooks?utm_source=docs\&utm_medium=use-case-gallery) und klicken Sie auf **Create playbook**. Geben Sie ihm einen Namen und ein Makro (z. B. `!add-docs`).

      Schreiben Sie konkrete, schrittweise Anweisungen. Verweisen Sie auf tatsächliche Dateipfade und Konventionen, damit Devin die Standards Ihres Teams einhält:

      <PromptBlock type="playbook">
        ```txt !add-docs playbook theme={null}
        Lies das Linear-Ticket, um Kontext zur Funktion oder zum Endpoint zu bekommen. Dann:

        1. Finde den relevanten Quellcode – Route-Handler, Controller,
           Models und Typdefinitionen
        2. Lies unsere bestehenden Docs in docs/api/, um das Format
           und die Konventionen zu verstehen, die wir verwenden
        3. Generiere Dokumentation, die Folgendes abdeckt: Endpoint-URL, HTTP-Methode,
           Request/Response-Schemas, Authentifizierungsanforderungen, Fehlercodes
           und ein Anwendungsbeispiel mit curl
        4. Füge die neue Seite in der Docs-Sidebar in docs/sidebar.json hinzu
        5. Wenn es verwandte Endpoints gibt, füge Querverweise hinzu
        6. Öffne einen Pull-Request (PR) mit der neuen Dokumentation
        ```
      </PromptBlock>

      Je spezifischer Ihr Playbook ist, desto besser wird das Ergebnis. Verweisen Sie auf die tatsächlichen Dokumentvorlagen, Styleguides und Tools Ihres Teams. Weitere Informationen zum Schreiben effektiver Playbooks finden Sie in der [Playbook-Dokumentation](/de/product-guides/creating-playbooks).
    </Step>

    <Step title="Playbook mit Linear synchronisieren">
      Richte deine [Linear-Integration](/de/integrations/linear) ein, falls du das noch nicht getan hast: Navigiere zu [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery) und klicke auf **Connect**. Wähle die Teams aus, auf die Devin Zugriff haben soll.

      Sobald die Verbindung hergestellt ist, scrolle zu **Synced playbook labels** und klicke auf **Add playbook**. Wähle `!add-docs` aus der Dropdown-Liste. Dadurch wird automatisch ein Label namens `!add-docs` in Linear unter der Label-Gruppe **Devin Playbooks** erstellt.

      Wenn jetzt jemand dieses Label zu einem Ticket hinzufügt, startet Devin eine Sitzung mit deinem Playbook.

      <Note>Damit Playbook-Labels automatisch mit Linear synchronisiert werden, muss in deinem Linear-Workspace **Manage workspace labels** auf **All members** gesetzt sein (zu finden unter Linears **Settings > Security**). Wenn das nicht aktiviert ist, musst du die Labels manuell in Linear anlegen.</Note>
    </Step>

    <Step title="Tickets kennzeichnen und Dokumentation generieren">
      Wenn ein Teammitglied das Label `!add-docs` zu einem Ticket wie diesem hinzufügt:

      > **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.

      startet Devin automatisch eine Sitzung und folgt eurem Docs-Playbook:

      * **Liest das Ticket** — übernimmt die Beschreibung des Endpoints, Parameter und verlinkte PRs
      * **Findet den Quellcode** — findet den Route-Handler, das Request-Validierungsschema und die Response-Typen
      * **Generiert Dokumentation** — erstellt eine neue Seite in `docs/api/` entsprechend eurem bestehenden Format
      * **Öffnet eine PR** — enthält die neue Dokumentationsseite und die aktualisierte Sidebar

      Das funktioniert auch gut für Batch-Operationen — wählt mehrere Tickets mit **Cmd+A** aus, klickt mit der rechten Maustaste und fügt das Label `!add-docs` hinzu, um Dokumentation für mehrere Endpoints parallel zu erstellen.

      <Tip>Mit der installierten Linear-Integration hat Devin nativen Zugriff auf die Tools von Linear — euer Playbook kann Devin also anweisen, Ticket-Labels oder -Status basierend auf dem Ergebnis zu aktualisieren. Da Labels andere Automatisierungen auslösen können, könnt ihr Workflows verketten — z. B. könnte nach dem Generieren der Dokumentation ein `Docs Ready`-Label die technische Redaktion zur Überprüfung benachrichtigen.</Tip>
    </Step>

    <Step title="Erstellen Sie weitere Playbooks für Ihr Team">
      Dasselbe Muster funktioniert für jede wiederkehrende Aufgabe. Erstelle ein Playbook, synchronisiere es als Label, und dein Team kann es von jedem Ticket aus auslösen. Hier sind einige Ideen:

      * **`!write-tests`** — Testabdeckung für das im Ticket beschriebene Feature hinzufügen
      * **`!refactor`** — Code entsprechend den Konventionen deines Teams refaktorisieren
      * **`!security-audit`** — Code auf Sicherheitslücken prüfen und einen Pull Request (PR) mit Korrekturen eröffnen
      * **`!migrate`** — Eine standardisierte Migration ausführen (Upgrade von Abhängigkeiten, Erhöhung der API-Version)

      Du kannst auch [Automatisierungs-Trigger](/de/integrations/linear) einrichten, damit Devin mit der Arbeit beginnt, ohne dass jemand ein Label setzen muss. Gehe zu [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery), scrolle zu **Automation triggers** und konfiguriere einen Trigger, der ausgelöst wird, wenn Tickets in einen bestimmten Status wechseln oder ein bestimmtes Label erhalten.
    </Step>
  </Steps>
</div>