Visão Geral do Smart Engineering
O Smart Engineering apoia a jornada de modernização de código. O usuário cadastra um repositório, envia o código-fonte, revisa a pré-análise, cria tasks e usa os resultados para navegar por documentação, grafo técnico, logs e métricas de uso.
Após concluir a documentação, o usuário pode criar um projeto de Modernização de Código para compreender a aplicação atual, preparar um plano de modernização e gerar os arquivos de uma nova aplicação com o apoio de um assistente guiado.
O que você vê depende da organização ativa, do status do repositório, das opções de task disponíveis, da medição de uso habilitada e das permissões da sua conta.
Quando usar
- Use o módulo para documentar sistemas existentes a partir do código-fonte.
- Use-o para entender estrutura, dependências, linguagens e volume de código.
- Use-o para gerar documentação técnica, diagramas e artefatos de backlog.
- Use-o para investigar relações técnicas no grafo do repositório.
- Use-o quando a equipe precisa recuperar conhecimento sobre um sistema legado ou pouco documentado.
Antes de começar
- Confirme a organização ativa.
- Garanta que o repositório correto será criado ou selecionado.
- Prepare o código-fonte em um arquivo
.zip. - Confirme que sua conta pode acessar o módulo e executar tasks.
Entenda a aplicação
| Área | O que significa |
|---|---|
| Organização | Contexto que define quais repositórios, tasks, documentos, uso e métricas ficam disponíveis. |
| Repositório | Sistema que será analisado. Pode conter metadados, código enviado, pré-análise, tasks, documentação, grafo e dados de uso. |
| Código-fonte | Pacote .zip analisado pelo app para pré-análise, grafo e documentação. |
| Pré-análise | Resumo inicial do repositório com arquivos, linhas, stacks, estimativas de custo, janela de contexto e recomendações quando disponíveis. |
| Task | Execução que pode gerar documentação, diagramas, artefatos de backlog ou outros resultados selecionados. |
| Workspace do repositório | Área com visão geral, código-fonte, tasks, documentação e grafo. |
| Modernização de Código | Projeto guiado que usa a documentação concluída do repositório como ponto de partida para planejar e gerar uma nova aplicação. |
| Command palette | Superfície rápida para encontrar telas e ações. |
Passo a passo
- Entre na aplicação.
- Confirme a organização ativa.
- Crie ou abra um repositório.
- Envie o código-fonte como
.zip. - Aguarde o processamento e revise a pré-análise.
- Crie uma task.
- Acompanhe status, logs e ações disponíveis.
- Leia a documentação gerada.
- Inicie um projeto de Modernização de Código quando quiser planejar e gerar uma nova aplicação.
- Explore grafo, referências e inspector de código quando precisar de contexto técnico.
- Consulte a medição de uso ou baixe o pacote de resultado quando necessário.
Navegação
A sidebar agrupa rotas de repositórios, conhecimento e administração. O header concentra controles globais, informações do usuário e acesso ao command palette. Em telas menores, parte dos controles globais fica no início do menu lateral para manter a área principal limpa.
A sidebar pode ser recolhida. No mobile, ela abre como painel lateral. Ações de repositório ficam agrupadas nas rotas de repositório, rotas de conhecimento cobrem documentação e exploração de grafo, e rotas de administração cobrem API keys e medição de uso quando habilitada.
O command palette pode abrir telas de repositório, conhecimento e administração. As ações disponíveis dependem do repositório atual, das features habilitadas e das permissões da conta.
Workspace do repositório
O workspace em /repositories/:repositoryId reúne header, breadcrumb, status e abas do ciclo do repositório:
- Visão geral
- Código-fonte
- Tasks
- Documentação
- Grafo Algumas abas podem ficar bloqueadas até existir código-fonte ou pré-análise.
A medição de uso não faz parte das abas do workspace. Quando habilitada, ela fica disponível pela área de administração e permite selecionar o repositório dentro da própria tela.
Resultado esperado
Ao fim do fluxo, o repositório deve ter código processado, pré-análise disponível, uma ou mais tasks executadas, documentação gerada, referências de grafo e dados de uso quando a medição de uso estiver habilitada. Quando a Modernização de Código é utilizada, o projeto também mantém o plano, os documentos e os arquivos gerados disponíveis para revisão ou download.