Atualize a documentação automaticamente a partir de dúvidas de suporte

Quando a mesma dúvida de suporte aparece três vezes, o Zero rascunha uma atualização na documentação e abre um PR, para que a próxima pessoa encontre a resposta antes de perguntar.

O Zero conecta:

O que o Zero entrega

Atualize a documentação automaticamente a partir de dúvidas de suporte — sample output from Zero — screenshot 1

Qual é o problema

Todo canal de suporte tem cinco ou seis dúvidas que nunca morrem, não porque o produto seja confuso, mas porque a documentação não as menciona. Acompanhar essas threads manualmente, rascunhar atualizações e empurrar PRs é o tipo de trabalho que sempre escapa. O Docs Auto-Update fica de olho nos seus canais de suporte, conta as dúvidas recorrentes e, no momento em que uma dúvida foi feita três ou mais vezes por pessoas diferentes, ele rascunha uma atualização na documentação e abre um PR. Um revisor gasta dois minutos aprovando. A próxima pessoa que tiver a mesma dúvida encontra a resposta em vez de perguntar.

Como o Zero resolve

Passo 1: conecte suas ferramentas

Slack

Obrigatório

Slack. O Zero lê seus canais de suporte para detectar dúvidas recorrentes. É necessário acesso de leitura aos canais que você indicar.

Conectar

GitHub

Obrigatório

GitHub. O Zero rascunha atualizações de documentação como PRs no repositório do seu site. É necessário acesso de escrita ao repositório para que o Zero possa criar branches e abrir PRs.

Conectar

Notion

Opcional

Notion. Opcional. Útil se sua documentação interna fica no Notion e você quer que o Zero atualize aquilo também.

Conectar

Passo 2: peça ao Zero

@Zero toda semana, varra #support e #community em busca de dúvidas que foram feitas por mais de 3 pessoas diferentes nos últimos 14 dias. Para cada uma, rascunhe uma atualização na documentação e abra um PR no repositório do site com a mudança.

experimente

O Zero fica de olho nos seus canais de suporte em busca de dúvidas recorrentes

O Zero lê as threads de suporte que chegam, agrupa semanticamente dúvidas parecidas e conta quem perguntou de forma única. Dúvidas de mais de 3 usuários distintos em uma janela móvel são sinalizadas como lacunas de documentação.

O Zero rascunha uma atualização na documentação com base nas respostas resolvidas

Para cada dúvida sinalizada, o Zero lê a resolução da thread, identifica o local certo na documentação (seção existente ou novo guia) e rascunha a atualização no formato markdown do seu site, com exemplos concretos.

O Zero abre um PR para revisão

Cada rascunho chega como um PR no repositório do seu site, com as threads das dúvidas que o motivaram vinculadas na descrição. Um revisor da equipe de documentação aprova; você não escreve do zero.

Passo 3: leve mais longe

Encaminhar para o revisor certo

Atribua os PRs ao responsável pelo componente em vez de um revisor genérico.

@Zero ao rascunhar documentação para uma dúvida de cobrança, marque @billing-team no PR em vez de @docs-team.

experimente

Publicar automaticamente atualizações de baixo risco

Deixe correções de digitação e pequenas clarificações irem ao ar sem revisão humana.

@Zero para PRs de documentação com menos de 50 linhas que só tocam seções existentes, habilite o auto-merge assim que a CI passar.

experimente

Ampliar a cobertura

Adicione novos canais de origem para sinal.

@Zero varra também a caixa de entrada de suporte do Gmail em busca de dúvidas recorrentes, não só o Slack.

experimente

Dicas para melhores resultados

●Defina o limiar de 'recorrente' em 3 pessoas únicas em 14 dias, não 1. Em 1 você só está reescrevendo a documentação todo dia; em 3 você está pegando lacunas reais.

●Sempre inclua as threads de origem na descrição do PR. Os revisores conseguem ver as dúvidas originais e julgar se o rascunho de fato as responde.

●Combine com o KB Capture para que as threads resolvidas fluam para a sua base de conhecimento interna em paralelo.