Criando um Repositório
Crie um repositório em /repositories/create para cadastrar o sistema que o Smart Engineering vai analisar. Abra a tela em Repositórios → Novo Repositório na barra lateral. Um repositório deve pertencer à organização ativa.
Quando usar
- Quando um sistema ainda não está cadastrado.
- Para iniciar uma nova jornada de documentação ou modernização.
- Antes de enviar o código-fonte que será analisado.
Antes de começar
- Confirme a organização ativa.
- Defina um nome de repositório reconhecível.
- Prepare uma descrição com contexto suficiente para orientar a geração.
Campos principais
O fluxo de criação coleta as informações necessárias para identificar e contextualizar o sistema:
| Campo | Descrição | Orientação |
|---|---|---|
| Nome | Um nome de repositório claro. | Use um nome que as equipes reconheçam depois em listas, processos e documentação gerada. |
| Descrição | Um resumo do contexto do repositório. | Inclua objetivo de negócio, escopo, módulos importantes, integrações, riscos ou restrições conhecidas. |
| Organização | O contexto da organização ativa. | Confirme que a organização selecionada é a correta antes de criar o repositório. |
| Informações de apoio | Orientações exibidas durante o fluxo de configuração. | Use-as para confirmar o que será analisado antes de indexar o código-fonte. |
Passo a passo
- Abra a criação de repositório.
- Confirme a organização ativa.
- Preencha nome e descrição.
- Revise as informações no stepper de configuração.
- Confirme a criação.
- Continue no workspace do repositório, a partir da etapa de Indexação.
Componentes da tela
A tela de criação inclui:
- Stepper de configuração do repositório.
- Card de detalhes do repositório.
- Caixa de diálogo de confirmação de criação.
- Caixa de diálogo para descartar alterações.
- Orientação sobre o indexador suportado.
Descrição recomendada
Uma boa descrição melhora o contexto disponível para os artefatos gerados. Inclua:
- O objetivo de negócio do sistema.
- As principais áreas funcionais ou módulos.
- Stakeholders ou usuários-chave.
- Integrações importantes.
- Riscos técnicos ou restrições de legado.
- Qualquer objetivo de modernização já conhecido pela equipe.
Exemplo:
Este repositório dá suporte ao onboarding de clientes no canal de varejo bancário.
Inclui validação de conta, verificação de documentos, regras de elegibilidade e
integração com o serviço de perfil do cliente. O objetivo de modernização é
documentar os fluxos existentes e identificar candidatos para extração de APIs.
Resultado esperado
Após a criação, a aplicação abre o workspace do repositório para você continuar a partir da etapa de Indexação.