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

# Generar automáticamente documentación de la API desde 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="Generar automáticamente documentación de API desde Linear" description="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." prompt="Crea un playbook llamado !add-docs que genere documentación de API para el endpoint descrito en un ticket de Linear, siguiendo nuestras convenciones de documentación." category="Gestión de proyectos" features="Integraciones, Playbooks" devinUrl="https://app.devin.ai/settings/connections/linear" />

<div className="uc-detail-wrapper">
  <Tip>¿No quieres configurarlo manualmente? Pega un enlace a esta página en una sesión de Devin y pídele que lo configure todo por ti.</Tip>

  <Steps>
    <Step title="Crea un playbook de documentación">
      Comienza creando un [playbook](/es/product-guides/creating-playbooks) 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**](https://app.devin.ai/settings/playbooks?utm_source=docs\&utm_medium=use-case-gallery) 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:

      <PromptBlock type="playbook">
        ```txt !add-docs playbook theme={null}
        Lee el ticket de Linear para obtener contexto sobre la funcionalidad o el endpoint. Luego:

        1. Encuentra el código fuente relevante: handlers de rutas, controladores,
           modelos y definiciones de tipos
        2. Lee nuestra documentación existente en docs/api/ para entender el formato
           y las convenciones que usamos
        3. Genera documentación que cubra: URL del endpoint, método HTTP,
           esquemas de petición/respuesta, requisitos de autenticación, códigos de error
           y un ejemplo de uso con curl
        4. Añade la nueva página a la barra lateral de la documentación en docs/sidebar.json
        5. Si hay endpoints relacionados, añade referencias cruzadas
        6. Abre un PR con la nueva documentación
        ```
      </PromptBlock>

      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](/es/product-guides/creating-playbooks) para más información sobre cómo escribir playbooks efectivos.
    </Step>

    <Step title="Sincronizar el playbook con Linear">
      Conecta tu [integración con Linear](/es/integrations/linear) si aún no lo has hecho: ve a [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery) 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.

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

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

      Esto también funciona bien para operaciones por lotes: selecciona varios tickets con **Cmd+A**, haz clic derecho y agrega la etiqueta `!add-docs` para generar documentación para múltiples endpoints en paralelo.

      <Tip>Con la integración de Linear instalada, Devin tiene acceso nativo a las herramientas de Linear, por lo que tu playbook puede instruir a Devin para actualizar las etiquetas o el estado de los tickets según el resultado. Dado que las etiquetas pueden desencadenar otras automatizaciones, puedes encadenar flujos de trabajo; por ejemplo, después de que se genere la documentación, una etiqueta `Docs Ready` podría notificar al redactor técnico para que la revise.</Tip>
    </Step>

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

      También puedes configurar [disparadores de automatización](/es/integrations/linear) para que Devin comience a trabajar sin que nadie tenga que aplicar una etiqueta. Ve a [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery), desplázate hasta **Automation triggers** y configura un disparador que se active cuando los tickets pasen a un estado o etiqueta específicos.
    </Step>
  </Steps>
</div>