Ir al contenido principal

Acceso a los Resultados Generados

Cuando un proceso termina con éxito, Smart Engineering pone a disposición la salida generada en el workspace del repositorio, en la vista global de documentación, en las pantallas de grafo y en paquetes .zip descargables cuando están disponibles.

Cuándo usar​

  • Use la documentación para leer las páginas generadas dentro de la aplicación.
  • Use la descarga cuando los artefactos deban compartirse, archivarse o editarse fuera de la aplicación.
  • Use el grafo para investigar relaciones técnicas y dependencias en el código analizado.

Documentación​

Abra /repositories/:repositoryId/documentation para leer la documentación de un repositorio, o /documentation para comenzar desde la vista global de documentación.

La documentación se carga bajo demanda:

  1. La aplicación obtiene las páginas de documentación disponibles.
  2. Construye la navegación lateral.
  3. Abre la primera página disponible por defecto.
  4. Obtiene el contenido de la página cuando el usuario navega.

Esto evita cargar todo el contenido de una vez y permite navegar por las páginas reales de documentación. La vista de documentación permite:

  • Cargar la documentación del repositorio.
  • Seleccionar un repositorio con documentación disponible.
  • Ver los repositorios no disponibles por separado.
  • Buscar archivos o categorías.
  • Navegar por el árbol lateral.
  • Abrir páginas Markdown.
  • Leer el Markdown renderizado.
  • Abrir diagramas Mermaid.
  • Recargar la documentación.
  • Volver a la pantalla anterior sin entrar en un bucle.
  • Descargar los resultados cuando hay un paquete disponible.

La página incluye estados para selección de repositorio, carga de documentación, documentación cargada, documentación vacía, errores de carga y resultados filtrados sin coincidencias.

Descarga del paquete de resultados​

También puede descargar el resultado generado de un proceso exitoso.

  1. Abra el proceso completado.
  2. Haga clic en Descargar Resultados.
  3. Extraiga el archivo .zip descargado.
  4. Abra los archivos HTML o Markdown generados localmente.

Según las opciones de proceso seleccionadas, el paquete puede incluir documentación, diagramas, artefactos de backlog y archivos de apoyo.

La documentación generada está disponible como contenido renderizado en la app y como archivos de origen para revisión o personalización fuera de ella. La salida HTML se puede abrir en un navegador, mientras que la salida Markdown se puede abrir en un IDE o una herramienta de documentación.

Grafo del repositorio​

Abra /repositories/:repositoryId/graph para explorar las relaciones identificadas en el código analizado. El grafo ayuda a los usuarios técnicos a investigar nodos, relaciones, archivos, elementos de código, dependencias y referencias.

Puede buscar archivos, seleccionar archivos o elementos de código, inspeccionar referencias, abrir documentación relacionada y usar asistencia de IA cuando esté configurada.

La asistencia de IA depende de los modelos y la configuración disponibles para la organización.

Grafo global​

Abra el grafo global cuando necesite trabajar fuera del workspace de un repositorio específico. Tiene dos modos:

  • Seleccionar repositorio existente: elija un repositorio disponible y cargue su grafo. Los repositorios sin código fuente no deben aparecer como opciones cargables.
  • Cargar código: suba un archivo .zip para generar un grafo a partir del código proporcionado.

Contenido acumulativo​

La documentación generada puede ser acumulativa. Por ejemplo, después de ejecutar un proceso con salidas de documentación y luego otro con salidas de backlog, los paquetes de resultados posteriores pueden incluir información producida por ambas ejecuciones.

Resultado esperado​

Debería poder navegar por la documentación en vivo por página, explorar relaciones técnicas mediante los flujos de grafo de repositorio o global, usar el chat de IA cuando esté configurado y descargar un paquete con los artefactos generados cuando esté disponible.

Ver también​