Pular para o conteúdo principal

Acessando os Resultados Gerados

Quando um processo termina com sucesso, o Smart Engineering disponibiliza a saída gerada no workspace do repositório, na visão global de documentação, nas telas de grafo e em pacotes .zip para download quando disponíveis.

Quando usar​

  • Use a documentação para ler as páginas geradas dentro da aplicação.
  • Use o download quando os artefatos precisam ser compartilhados, arquivados ou editados fora da aplicação.
  • Use o grafo para investigar relações técnicas e dependências no código analisado.

Documentação​

Abra /repositories/:repositoryId/documentation para ler a documentação de um repositório, ou /documentation para começar pela visão global de documentação.

A documentação é carregada sob demanda:

  1. A aplicação busca as páginas de documentação disponíveis.
  2. Monta a navegação lateral.
  3. Abre a primeira página disponível por padrão.
  4. Busca o conteúdo da página quando o usuário navega.

Isso evita carregar todo o conteúdo de uma vez e permite navegar pelas páginas reais de documentação. A visão de documentação permite:

  • Carregar a documentação do repositório.
  • Selecionar um repositório com documentação disponível.
  • Ver repositórios indisponíveis separadamente.
  • Buscar arquivos ou categorias.
  • Navegar pela árvore lateral.
  • Abrir páginas Markdown.
  • Ler o Markdown renderizado.
  • Abrir diagramas Mermaid.
  • Recarregar a documentação.
  • Voltar à tela anterior sem entrar em loop.
  • Baixar os resultados quando há um pacote disponível.

A página inclui estados para seleção de repositório, carregamento de documentação, documentação carregada, documentação vazia, erros de carregamento e resultados filtrados sem correspondência.

Baixando o pacote de resultado​

Você também pode baixar o resultado gerado de um processo bem-sucedido.

  1. Abra o processo concluído.
  2. Clique em Baixar Resultados.
  3. Extraia o arquivo .zip baixado.
  4. Abra os arquivos HTML ou Markdown gerados localmente.

Dependendo das opções de processo selecionadas, o pacote pode incluir documentação, diagramas, artefatos de backlog e arquivos de apoio.

A documentação gerada fica disponível como conteúdo renderizado no app e como arquivos de origem para revisão ou personalização fora dele. A saída HTML pode ser aberta em um navegador, enquanto a saída Markdown pode ser aberta em uma IDE ou ferramenta de documentação.

Grafo do repositório​

Abra /repositories/:repositoryId/graph para explorar as relações identificadas no código analisado. O grafo ajuda usuários técnicos a investigar nós, relações, arquivos, elementos de código, dependências e referências.

Você pode buscar arquivos, selecionar arquivos ou elementos de código, inspecionar referências, abrir documentação relacionada e usar a assistência de IA quando ela estiver configurada.

A assistência de IA depende dos modelos e da configuração disponíveis para a organização.

Grafo global​

Abra o grafo global quando precisar trabalhar fora do workspace de um repositório específico. Ele tem dois modos:

  • Selecionar repositório existente: escolha um repositório disponível e carregue o grafo dele. Repositórios sem código-fonte não devem aparecer como opções carregáveis.
  • Enviar código: envie um arquivo .zip para gerar um grafo a partir do código informado.

Conteúdo cumulativo​

A documentação gerada pode ser cumulativa. Por exemplo, depois de executar um processo com saídas de documentação e, em seguida, outro com saídas de backlog, os pacotes de resultado posteriores podem incluir informações produzidas por ambas as execuções.

Resultado esperado​

Você deve conseguir navegar pela documentação ao vivo por página, explorar relações técnicas pelos fluxos de grafo de repositório ou global, usar o chat de IA quando configurado e baixar um pacote com os artefatos gerados quando disponível.

Veja também​