Descripción General de Smart Engineering
Smart Engineering apoya la jornada de modernización de código. El usuario registra un repositorio, carga el código fuente, revisa el preanálisis, crea tareas y usa los resultados para navegar por documentación, grafo técnico, logs y métricas de uso.
Después de finalizar la documentación, el usuario puede crear un proyecto de Modernización de Código para comprender la aplicación actual, preparar un plan de modernización y generar los archivos de una nueva aplicación con la ayuda de un asistente guiado.
Lo que ve depende de la organización activa, el estado del repositorio, las opciones de tarea disponibles, la medición de uso habilitada y los permisos asignados a su cuenta.
Cuándo usar
- Use el módulo para documentar sistemas existentes a partir del código fuente.
- Úselo para entender estructura, dependencias, lenguajes y volumen de código.
- Úselo para generar documentación técnica, diagramas y artefactos de backlog.
- Úselo para investigar relaciones técnicas en el grafo del repositorio.
- Úselo cuando el equipo necesite recuperar conocimiento sobre un sistema legado o poco documentado.
Antes de empezar
- Confirme la organización activa.
- Asegúrese de que se creará o seleccionará el repositorio correcto.
- Prepare el código fuente en un archivo
.zip. - Confirme que su cuenta puede acceder al módulo y ejecutar tareas.
Entienda la aplicación
| Área | Qué significa |
|---|---|
| Organización | Contexto que define qué repositorios, tareas, documentos, uso y métricas están disponibles. |
| Repositorio | Sistema que será analizado. Puede contener metadatos, código cargado, preanálisis, tareas, documentación, grafo y datos de uso. |
| Código fuente | Paquete .zip analizado por la app para preanálisis, grafo y documentación. |
| Preanálisis | Resumen inicial del repositorio con archivos, líneas, stacks, estimaciones de costo, ventana de contexto y recomendaciones cuando estén disponibles. |
| Tarea | Ejecución que puede generar documentación, diagramas, artefactos de backlog u otros resultados seleccionados. |
| Workspace del repositorio | Área con descripción general, código fuente, tareas, documentación y grafo. |
| Modernización de Código | Proyecto guiado que usa la documentación finalizada del repositorio como punto de partida para planificar y generar una nueva aplicación. |
| Command palette | Superficie rápida para encontrar pantallas y acciones. |
Paso a paso
- Entre en la aplicación.
- Confirme la organización activa.
- Cree o abra un repositorio.
- Cargue el código fuente como
.zip. - Espere el procesamiento y revise el preanálisis.
- Cree una tarea.
- Monitoree estado, logs y acciones disponibles.
- Lea la documentación generada.
- Inicie un proyecto de Modernización de Código cuando quiera planificar y generar una nueva aplicación.
- Explore grafo, referencias e inspector de código cuando necesite contexto técnico.
- Consulte la medición de uso o descargue el paquete de resultado cuando sea necesario.
Navegación
La sidebar agrupa rutas de repositorios, conocimiento y administración. El header concentra controles globales, información del usuario y acceso al command palette. En pantallas pequeñas, parte de los controles globales queda al inicio del menú lateral para mantener limpia el área principal.
El command palette puede abrir pantallas de repositorio, conocimiento y administración. Las acciones disponibles dependen del repositorio actual, las features habilitadas y los permisos de la cuenta.
Workspace del repositorio
El workspace en /repositories/:repositoryId reúne header, breadcrumb, estado y pestañas del ciclo del repositorio:
- Descripción general
- Código fuente
- Tareas
- Documentación
- Grafo Algunas pestañas pueden quedar bloqueadas hasta que exista código fuente o preanálisis.
La medición de uso no forma parte de las pestañas del workspace. Cuando está habilitada, queda disponible en el área de administración.
Resultado esperado
Al final del flujo, el repositorio debe tener código procesado, preanálisis disponible, una o más tareas ejecutadas, documentación generada, referencias de grafo y datos de uso cuando la medición de uso esté habilitada. Cuando se usa la Modernización de Código, el proyecto también mantiene el plan, los documentos y los archivos generados disponibles para revisión o descarga.