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

# Genera automaticamente la documentazione delle API da 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="Genera automaticamente la documentazione API da Linear" description="Crea un playbook per la documentazione, sincronizzalo come etichetta in Linear e consenti a chiunque nel tuo team di avviare la generazione della documentazione etichettando un ticket." prompt="Crea un playbook chiamato !add-docs che genera la documentazione API per l'endpoint descritto in un ticket Linear, seguendo le nostre convenzioni di documentazione." category="Gestione dei progetti" features="Integrazioni, Playbook" devinUrl="https://app.devin.ai/settings/connections/linear" />

<div className="uc-detail-wrapper">
  <Tip>Non vuoi configurare tutto manualmente? Incolla un link a questa pagina in una sessione di Devin e chiedi a lui di impostare tutto per te.</Tip>

  <Steps>
    <Step title="Scrivi un playbook per la documentazione">
      Inizia creando un [playbook](/it/product-guides/creating-playbooks) per l’attività che vuoi standardizzare. In questo esempio creeremo un playbook che genera la documentazione delle API ogni volta che un membro del team applica un’etichetta a un ticket.

      Vai su [**Settings > Playbooks**](https://app.devin.ai/settings/playbooks?utm_source=docs\&utm_medium=use-case-gallery) e fai clic su **Create playbook**. Assegnagli un nome e una macro (ad es. `!add-docs`).

      Scrivi istruzioni specifiche e dettagliate, passo per passo. Fai riferimento a percorsi di file reali e alle convenzioni, in modo che Devin segua gli standard del tuo team:

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

      Più il tuo playbook è specifico, migliore sarà il risultato. Fai riferimento ai template di documentazione effettivi del tuo team, alle guide di stile e agli strumenti che utilizzate. Consulta la [documentazione sui playbook](/it/product-guides/creating-playbooks) per maggiori informazioni sulla scrittura di playbook efficaci.
    </Step>

    <Step title="Sincronizza il playbook su Linear">
      Collega la tua [integrazione Linear](/it/integrations/linear) se non l'hai già fatto: vai su [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery) e fai clic su **Connect**. Seleziona i team a cui Devin deve avere accesso.

      Una volta collegata l'integrazione, scorri fino a **Synced playbook labels** e fai clic su **Add playbook**. Seleziona `!add-docs` dal menu a discesa. Questo crea automaticamente un'etichetta chiamata `!add-docs` in Linear, all'interno del gruppo di etichette **Devin Playbooks**.

      Ora, quando qualcuno aggiunge quell'etichetta a un ticket, Devin avvia una sessione utilizzando il tuo playbook.

      <Note>Affinché le etichette dei playbook vengano sincronizzate automaticamente con Linear, il tuo workspace di Linear deve avere **Manage workspace labels** impostato su **All members** (lo trovi in **Settings > Security** di Linear). Se questa opzione non è abilitata, dovrai creare manualmente le etichette in Linear.</Note>
    </Step>

    <Step title="Applica etichette ai ticket e genera documentazione">
      Quando un membro del team aggiunge l'etichetta `!add-docs` a un ticket come questo:

      > **ENG-215**: Aggiungi endpoint POST /api/v2/webhooks — accetta un URL e tipi di evento, verifica che l'URL sia raggiungibile, registra la sottoscrizione e restituisce l'ID del webhook.

      Devin avvia automaticamente una sessione e segue il tuo playbook per la documentazione:

      * **Legge il ticket** — estrae la descrizione dell'endpoint, i parametri e qualsiasi pull request (PR) collegata
      * **Trova il codice sorgente** — individua l'handler della route, lo schema di validazione della richiesta e i tipi di risposta
      * **Genera la documentazione** — crea una nuova pagina in `docs/api/` seguendo il tuo formato esistente
      * **Apre una PR** — include la nuova pagina di documentazione e la sidebar aggiornata

      Questo funziona bene anche per operazioni batch — seleziona più ticket con **Cmd+A**, fai clic con il tasto destro e aggiungi l'etichetta `!add-docs` per generare la documentazione di più endpoint in parallelo.

      <Tip>Con l'integrazione Linear installata, Devin ha accesso nativo agli strumenti di Linear — quindi il tuo playbook può istruire Devin ad aggiornare le etichette o lo stato dei ticket in base all'esito. Poiché le etichette possono attivare altre automazioni, puoi collegare i workflow in catena — ad es., dopo che la documentazione è stata generata, un'etichetta `Docs Ready` potrebbe notificare il redattore tecnico per la revisione.</Tip>
    </Step>

    <Step title="Crea altri playbook per il tuo team">
      Lo stesso modello funziona per qualsiasi attività ricorrente. Crea un playbook, sincronizzalo come etichetta e il tuo team potrà attivarlo da qualsiasi ticket. Ecco alcune idee:

      * **`!write-tests`** — Aggiungi copertura di test per la funzionalità descritta in un ticket
      * **`!refactor`** — Effettua il refactoring del codice seguendo le convenzioni del tuo team
      * **`!security-audit`** — Esamina il codice per individuare vulnerabilità di sicurezza e apri una PR con le correzioni
      * **`!migrate`** — Esegui una migrazione standardizzata (aggiornamento delle dipendenze, aggiornamento della versione dell'API)

      Puoi anche configurare [automation triggers](/it/integrations/linear) in modo che Devin inizi a lavorare senza che nessuno debba applicare un'etichetta. Vai su [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery), scorri fino a **Automation triggers** e configura un trigger che si attiva quando i ticket passano a uno specifico stato o etichetta.
    </Step>
  </Steps>
</div>