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

# Gerar documentação de API automaticamente a partir do 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="Gerar automaticamente documentação de API a partir do Linear" description="Crie um playbook de documentação, sincronize-o como uma etiqueta no Linear e permita que qualquer pessoa da sua equipe acione a geração de documentação ao etiquetar um ticket." prompt="Crie um playbook chamado !add-docs que gere documentação de API para o endpoint descrito em um ticket do Linear, seguindo nossas convenções de documentação." category="Gerenciamento de projetos" features="Integrações, Playbooks" devinUrl="https://app.devin.ai/settings/connections/linear" />

<div className="uc-detail-wrapper">
  <Tip>Não quer configurar isso manualmente? Cole um link para esta página em uma sessão do Devin e peça que ele configure tudo para você.</Tip>

  <Steps>
    <Step title="Crie um playbook de documentação">
      Comece criando um [playbook](/pt-BR/product-guides/creating-playbooks) para a tarefa que você deseja padronizar. Neste exemplo, vamos criar um playbook que gera documentação de API sempre que um membro do time marca um ticket com um rótulo.

      Vá para [**Settings > Playbooks**](https://app.devin.ai/settings/playbooks?utm_source=docs\&utm_medium=use-case-gallery) e clique em **Create playbook**. Dê a ele um nome e uma macro (por exemplo, `!add-docs`).

      Escreva instruções específicas, passo a passo. Use caminhos de arquivos reais e convenções que permitam que o Devin siga os padrões do seu time:

      <PromptBlock type="playbook">
        ```txt !add-docs playbook theme={null}
        Leia o ticket no Linear para obter contexto sobre a feature ou endpoint. Em seguida:

        1. Encontre o código-fonte relevante — route handlers, controllers,
           models e definições de tipos
        2. Leia nossa documentação existente em docs/api/ para entender o formato
           e as convenções que usamos
        3. Gere a documentação cobrindo: URL do endpoint, método HTTP,
           esquemas de requisição/resposta, requisitos de autenticação, códigos de erro
           e um exemplo de uso com curl
        4. Adicione a nova página à barra lateral da documentação em docs/sidebar.json
        5. Se houver endpoints relacionados, adicione referências cruzadas
        6. Abra um PR com a nova documentação
        ```
      </PromptBlock>

      Quanto mais específico for o seu playbook, melhor será o resultado. Use os modelos de documentação reais do seu time, guias de estilo e ferramentas. Consulte a [documentação de playbooks](/pt-BR/product-guides/creating-playbooks) para saber mais sobre como escrever playbooks eficazes.
    </Step>

    <Step title="Sincronize o playbook com o Linear">
      Conecte sua [integração com o Linear](/pt-BR/integrations/linear), se ainda não tiver feito isso: vá para [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery) e clique em **Connect**. Selecione as equipes às quais o Devin deve ter acesso.

      Depois de conectar, role até **Synced playbook labels** e clique em **Add playbook**. Selecione `!add-docs` no menu suspenso. Isso cria automaticamente um rótulo chamado `!add-docs` no Linear, no grupo de rótulos **Devin Playbooks**.

      Agora, quando alguém adicionar esse rótulo a um ticket, o Devin iniciará uma sessão usando seu playbook.

      <Note>Para que os rótulos de playbook sejam sincronizados automaticamente com o Linear, seu workspace do Linear deve ter **Manage workspace labels** definido como **All members** (em **Settings > Security** do Linear). Se isso não estiver habilitado, você precisará criar os rótulos manualmente no Linear.</Note>
    </Step>

    <Step title="Rotular tickets e gerar documentação">
      Quando um membro da equipe adiciona o rótulo `!add-docs` a um ticket como este:

      > **ENG-215**: Adicionar endpoint POST /api/v2/webhooks — aceita uma URL e tipos de evento, verifica se a URL é acessível, armazena a assinatura e retorna o ID do webhook.

      Devin inicia automaticamente uma sessão e segue o seu playbook de documentação:

      * **Lê o ticket** — extrai a descrição do endpoint, parâmetros e quaisquer PRs vinculados
      * **Encontra o código-fonte** — localiza o handler de rota, o esquema de validação da requisição e os tipos de resposta
      * **Gera a documentação** — cria uma nova página em `docs/api/` seguindo o seu formato existente
      * **Abre um PR** — inclui a nova página de documentação e a sidebar atualizada

      Isso funciona bem para operações em lote também — selecione vários tickets com **Cmd+A**, clique com o botão direito e adicione o rótulo `!add-docs` para gerar documentação para múltiplos endpoints em paralelo.

      <Tip>Com a integração do Linear instalada, Devin tem acesso nativo às ferramentas do Linear — então seu playbook pode instruir Devin a atualizar rótulos ou status dos tickets com base no resultado. Como rótulos podem acionar outras automações, você pode encadear fluxos de trabalho — por exemplo, depois que a documentação é gerada, um rótulo `Docs Ready` pode notificar o redator técnico para revisão.</Tip>
    </Step>

    <Step title="Crie mais playbooks para o seu time">
      O mesmo padrão funciona para qualquer tarefa recorrente. Crie um playbook, sincronize-o como um rótulo e sua equipe poderá acioná-lo a partir de qualquer ticket. Aqui vão algumas ideias:

      * **`!write-tests`** — Adicionar cobertura de testes para a funcionalidade descrita em um ticket
      * **`!refactor`** — Refatorar o código seguindo as convenções da sua equipe
      * **`!security-audit`** — Revisar o código em busca de vulnerabilidades de segurança e abrir um PR com as correções
      * **`!migrate`** — Executar uma migração padronizada (atualização de dependências, atualização de versão da API)

      Você também pode configurar [gatilhos de automação](/pt-BR/integrations/linear) para que o Devin comece a trabalhar sem que ninguém precise aplicar um rótulo. Vá para [**Settings > Connections > Linear**](https://app.devin.ai/settings/connections/linear?utm_source=docs\&utm_medium=use-case-gallery), role até **Automation triggers** e configure um gatilho que dispare quando os tickets forem movidos para um status ou rótulo específico.
    </Step>
  </Steps>
</div>