Documentação de Flowkits com IA

visão geral a fluid permite que você crie documentação técnica completa e padronizada automaticamente para seus flowkits usando inteligência artificial esta funcionalidade economiza tempo, garante consistência e facilita o onboarding de novos membros da equipe o que é a documentação automática? a documentação automática utiliza ia para analisar as configurações do seu flowkit (nome, fluxos, conexões, parâmetros) e gerar um documento técnico estruturado em formato markdown, seguindo as melhores práticas de documentação de software benefícios economia de tempo documentação completa em 10 segundos padronização todas as documentações seguem o mesmo formato completude a ia garante que nenhuma informação importante seja esquecida atualização fácil regenere sempre que fizer alterações no flowkit como acessar a documentação existem três formas de acessar a página de documentação de um flowkit 1\ durante a criação/edição no passo 5 revisão do wizard de criação ou edição, você verá uma seção "documentação" com um botão se não existir documentação "criar documentação" se já existir "editar documentação" clique para ser direcionado à página de documentação 2\ no card do flowkit no catálogo de flowkits, clique no menu de ações (três pontos) do card e selecione "ver documentação" (se já existe) "criar documentação" (se não existe) 3\ na página de detalhes na tela de detalhes do flowkit, navegue até a tab "documentação" gerando documentação com ia passo 1 acessar o editor acesse a página de documentação através de uma das formas descritas acima você verá o editor de documentação com a barra de ferramentas no topo passo 2 gerar com ia clique no botão "gerar com ai" na barra de ferramentas um modal de confirmação será exibido informando a ia criará uma documentação personalizada serão considerados automaticamente nome e identificador do flowkit todos os fluxos envolvidos conexões configuradas parâmetros definidos clique em "gerar documentação" aguarde aproximadamente 10 segundos atenção se o flowkit já possuir documentação, ela será substituída pela nova versão passo 3 revisar e personalizar após a geração, a documentação aparecerá no editor ela incluirá visão geral descrição, objetivo e categorias conectores necessários lista com conexões sugeridas fluxos incluídos detalhes de cada flow parâmetros de configuração tabela com tipos e descrições como ativar passo a passo para ativação fluxo de dados diagrama e exemplo prático troubleshooting problemas comuns e soluções informações técnicas metadados e suporte você pode editar qualquer seção manualmente para adicionar informações específicas passo 4 salvar clique em "salvar documentação" no rodapé da página estrutura da documentação gerada a ia segue um template fixo com 8 seções obrigatórias \# nome do flowkit versão v1 0 0 | criado por usuário | data dd/mm/yyyy \## 1 visão geral \[descrição automática baseada no flowkit] \## 2 conectores necessários \[tabela com conectores e conexões] \## 3 fluxos incluídos \[lista detalhada de cada flow] \## 4 parâmetros de configuração \[tabela com parâmetros obrigatórios/opcionais] \## 5 como ativar \[passo a passo de ativação] \## 6 fluxo de dados \[diagrama ascii + exemplo prático] \## 7 troubleshooting \[4 problemas comuns com soluções] \## 8 informações técnicas \[metadados, monitoramento e suporte] outras funcionalidades importar documentação ( md) se você já possui uma documentação em markdown clique em "importar md" selecione o arquivo md do seu computador o conteúdo será carregado no editor clique em "salvar documentação" exportar documentação ( md) para baixar a documentação como arquivo clique em "exportar md" o arquivo será baixado como {flowkit slug} documentation md use para compartilhar ou versionar externamente regenerar documentação se você fez alterações no flowkit (adicionou fluxos, mudou parâmetros) acesse a página de documentação clique em "gerar com ai" novamente a ia criará uma versão atualizada com as novas informações validações e guardrails a ia aplica validações automáticas para garantir qualidade campos obrigatórios nome do flowkit não pode estar vazio identificador (slug) deve estar em kebab case deve ter pelo menos 1 fluxo configurado limites de conteúdo descrição do flowkit máximo 500 caracteres descrição de cada flow máximo 200 caracteres descrição de parâmetros máximo 150 caracteres conteúdo excedente é truncado com " " fallbacks automáticos se categorias vazias "não categorizado" se casos de uso vazios "uso geral" se versão inválida "v1 0 0" se conectores de flow vazios "nenhum conector" editor de documentação a página de documentação possui um editor completo sidebar (esquerda) status indica se há documentação ou não última edição timestamp da última modificação metadados resumo do flowkit (fluxos, conexões, parâmetros) ações rápidas botões de geração e importação editor principal toolbar ações de geração, importação e exportação modo preview/markdown alternar entre edição e visualização syntax highlighting destaque de sintaxe markdown auto save (opcional) salvamento automático a cada 30s rodapé cancelar descarta alterações e volta salvar documentação salva e atualiza o flowkit casos de uso comuns caso 1 novo flowkit sem documentação crie um flowkit normalmente no passo 5, clique "criar documentação" na página de documentação, clique "gerar com ai" confirme no modal revise e salve caso 2 atualizar flowkit existente edite o flowkit (adicione flows, mude parâmetros) salve as alterações clique "editar documentação" clique "regenerar com ai" documentação será atualizada automaticamente caso 3 importar documentação externa acesse a página de documentação clique "importar md" selecione arquivo do seu computador edite se necessário salve caso 4 compartilhar documentação com equipe acesse a documentação do flowkit clique "exportar md" compartilhe o arquivo md via email, slack, etc ou compartilhe o link direto /flowkits/{slug}/documentation perguntas frequentes a documentação é versionada junto com o flowkit? sim quando você incrementa a versão do flowkit (ex v1 0 0 → v1 1 0), a documentação fica associada a essa versão posso editar manualmente a documentação gerada? sim, totalmente a ia gera uma base, mas você pode personalizar qualquer seção a documentação é visível para todos no workspace? sim qualquer usuário com acesso ao flowkit pode visualizar a documentação apenas usuários com permissões de edição podem modificar o que acontece se eu deletar um flow usado na documentação? a próxima vez que regenerar com ia, o flow deletado será removido automaticamente da documentação posso usar html dentro da documentação markdown? não recomendado a ia sanitiza html por segurança use apenas markdown padrão solução de problemas a geração de documentação falhou causa dados incompletos ou inválidos no flowkit solução verifique se o flowkit tem pelo menos 1 fluxo confirme que nome e slug estão preenchidos tente novamente documentação está desatualizada causa flowkit foi editado após a última geração de documentação solução acesse a página de documentação clique "regenerar com ai" salve a nova versão não consigo importar arquivo md causa arquivo muito grande ou formato inválido solução limite 50kb por arquivo certifique se que é um arquivo md válido tente copiar/colar o conteúdo diretamente no editor próximos passos depois de documentar seu flowkit ative o flowkit no ambiente desejado compartilhe a documentação com sua equipe mantenha atualizada sempre que fizer mudanças use como referência para troubleshooting leia também criando flowkits versionamento de flowkits parâmetros de flowkits precisa de ajuda? entre em contato mailto\ suporte\@fluidapi io