Assistente de IA para geração de documentação de cápsulas

Saiba como usar a funcionalidade para agilizar o processo de documentação de cápsulas.

Esta funcionalidade do conjunto de ferramentas de nossa Assistente de IA cria documentação para cápsulas, permitindo aos desenvolvedores poupar tempo, melhorar a consistência, além de aumentar a produtividade e a eficiência dos usuários ao abordar os desafios da documentação manual.

Cápsulas são um conjunto de conectores configurados que podem ser reutilizados em pipelines na Digibee Integration Platform. Para mais informações, leia nossa documentação.

Você pode usar a Assistente de IA para geração de documentação de cápsulas para:

  • Automatizar a criação de documentações: a IA analisa a funcionalidade da cápsula e cria automaticamente uma documentação detalhada, poupando tempo aos usuários.

  • Garantir consistência: ao padronizar o formato da documentação, a IA garante que todas as cápsulas sejam documentadas de forma consistente, reduzindo erros e ambiguidades.

  • Melhorar a compreensão: a documentação gerada inclui descrições claras sobre a finalidade, a funcionalidade e o uso da cápsula, facilitando para os desenvolvedores a compreensão do funcionamento dos pipelines e a correção de bugs.

  • Reduzir tarefas repetitivas: os desenvolvedores podem focar na criação de novas cápsulas em vez de documentar repetidamente as existentes, aumentando a produtividade.

  • Oferecer controle para o desenvolvedor: a documentação sugerida pode ser revisada, editada e publicada pelo desenvolvedor antes de ser compartilhada com os demais membros da equipe.

Como usar a funcionalidade Assistente de IA para geração de documentação de cápsulas:

Para usar a Assistente de IA para geração de documentação de cápsulas, siga os passos abaixo:

  1. Em uma cápsula, selecione o ícone de Configuração no canto superior direito. Dentro da aba Documentação, clique no botão Generate Documentation with AI.

  2. Assim que a cápsula for publicada, a documentação estará disponível no pipeline e poderá então ser acessada.

  3. Ao criar um pipeline, selecione sua cápsula e clique no ícone Documento para acessar a documentação da cápsula em markdown.

A documentação sempre será criada em inglês.

Atualizado