Documentação de fluxos com IA
Objetivo
O Canvas da Fluid conta com um agente de IA especializado capaz de gerar automaticamente a documentação técnica de qualquer fluxo. Com um único clique, o agente analisa a estrutura do fluxo — seus passos, conectores, templates e lógica de execução — e produz uma documentação clara e estruturada, pronta para ser compartilhada ou publicada.
Como funciona
O agente percorre todos os passos ativos do fluxo e gera uma documentação que inclui:
- Visão geral da integração, com um diagrama simplificado do fluxo de execução
- Descrição de cada passo: conector utilizado, função, configuração e próximo passo
- Templates completos (SQL/JSON) com explicação das variáveis utilizadas e sua origem
- Tabela de conexões referenciadas no fluxo
- Resumo da lógica em linguagem natural, explicando o que o fluxo faz do início ao fim
O resultado é entregue diretamente no Canvas, em português brasileiro, sem necessidade de nenhuma configuração adicional.
Como usar
- Abra o fluxo desejado no Canvas
- Clique em "AI Assistant" no topo da tela
- Aguarde alguns segundos enquanto o agente processa o fluxo
- A documentação gerada será exibida no painel lateral e poderá ser copiada
Exemplo de saída
A seguir, um exemplo do tipo de documentação gerada pelo agente para um fluxo de sincronização entre Omie e Supabase:
Fluxo: academycezar-omiesupabase Descrição: Integração Omie e Supabase
Visão Geral
Este fluxo sincroniza produtos do ERP Omie com uma base de dados Supabase. A lógica implementa um padrão de upsert: para cada produto retornado do Omie, verifica se já existe na base e decide entre atualizar ou cadastrar.
consulta (Omie) → loop → consultaprodutobase (SELECT) → condição
├─ true → atualiza-produto-base (UPDATE)
└─ false → cadastra-produto (INSERT)
next → lista-produto-base (SELECT)Resumo da Lógica
- Busca todos os produtos do Omie (paginado, 10 por página)
- Para cada produto, verifica se já existe na base
- Se existe → atualiza o nome do produto
- Se não existe → insere um novo registro
- Ao final, lista todos os registros da base para confirmação
Limitações desta versão
Nota sobre capacidade: O agente de documentação possui limites de processamento que variam conforme o tamanho e a complexidade do fluxo.
- Fluxos com templates mais concisos suportam até ~15 passos documentados
- Fluxos com templates maiores ou mais complexos suportam entre 8 e 10 passos
- Fluxos que excedam esses limites podem não ter a documentação gerada corretamente Para fluxos extensos, considere documentá-los em partes ou simplificar os templates antes de acionar o agente.
Boas práticas
- O agente documenta apenas passos ativos — passos desconectados do fluxo são ignorados
- Informações sensíveis, como tokens e senhas, são automaticamente omitidas da documentação gerada
- Para fluxos maiores ou com lógica complexa, revise a documentação gerada antes de publicar
- A documentação reflete o estado atual do fluxo — caso o fluxo seja editado, gere novamente para manter a doc atualizada
Perguntas frequentes
A documentação é salva automaticamente? Não. Após a geração, você pode copiar o conteúdo ou exportá-lo manualmente. A documentação não é versionada junto com o fluxo nesta versão inicial.
O agente documenta fluxos de qualquer tamanho? Sim, mas fluxos muito extensos podem levar alguns segundos a mais para serem processados.
A documentação gerada pode ser editada? O conteúdo gerado pode ser copiado e editado livremente em qualquer editor de texto ou diretamente no Archbee.