Aprende cómo Archyl usa IA para descubrir y documentar automáticamente tu arquitectura desde tu código

Descubrimiento con IA

La función de Descubrimiento IA de Archyl analiza tu código fuente para descubrir y documentar automáticamente tu arquitectura de software. Esto ahorra horas de trabajo de documentación manual y asegura que tu documentación de arquitectura se mantenga sincronizada con tu código real.

Cómo Funciona

1. Conecta Tu Repositorio

Primero, conecta tu repositorio Git a Archyl:

Ve a la configuración de tu proyecto
Haz clic en "Conectar Repositorio"
Elige tu proveedor Git (GitHub, GitLab, Bitbucket, etc.)
Autoriza a Archyl a acceder a tu repositorio

2. Inicia el Descubrimiento

Una vez conectado, inicia el descubrimiento IA:

Haz clic en "Iniciar Descubrimiento" en tu proyecto
Selecciona qué ramas o rutas analizar
Configura los ajustes de descubrimiento (opcional)
Haz clic en "Ejecutar Descubrimiento"

3. Análisis IA

La IA analiza tu código fuente para identificar:

Estructura del proyecto: Frameworks, lenguajes, sistemas de build
Servicios: Microservicios, APIs, workers en segundo plano
Almacenes de datos: Bases de datos, cachés, almacenamiento de archivos
Integraciones externas: APIs de terceros, servicios SaaS
Componentes: Módulos, paquetes, clases clave
Relaciones: Cómo se comunican los componentes

4. Revisar y Aprobar

Los descubrimientos se colocan en estado "Pendiente" para revisión:

Revisa cada elemento descubierto
Edita nombres, descripciones o relaciones
Aprueba los descubrimientos precisos
Rechaza o modifica los incorrectos

Tecnologías Soportadas

El Descubrimiento IA funciona mejor con:

Lenguajes

JavaScript/TypeScript
Python
Go
Java
C#
Ruby
PHP
Rust

Frameworks

React, Next.js, Vue, Angular
Express, Fastify, NestJS
Django, Flask, FastAPI
Spring Boot
ASP.NET Core
Ruby on Rails

Infraestructura

Docker/Kubernetes
Terraform
AWS CDK
Archivos de configuración cloud

Descubrimiento incremental

El descubrimiento incremental mantiene tu modelo C4 actualizado analizando solo los archivos que cambiaron — no el repositorio completo. Es mas rapido, mas economico y puede ejecutarse automaticamente en cada push.

Como funciona

Se hace push de codigo a la rama por defecto
Archyl recibe el evento push (via webhook o GitHub Action)
Los archivos modificados se extraen de los commits
Solo se analizan archivos fuente (los archivos eliminados se omiten)
La IA se ejecuta sobre el subconjunto de archivos
Los nuevos elementos se crean como descubrimientos pendientes
Los elementos existentes se deduplican automaticamente

Activar descubrimiento incremental

Hay dos formas de activar el descubrimiento incremental:

Webhook de GitHub — Activa Discovery on Push en la configuracion de webhooks de tu proyecto
GitHub Action (CI/CD) — Agrega la action Archyl Incremental Discovery a tu workflow. Consulta Integracion con GitHub Actions para instrucciones completas.

name: Architecture Sync
on:
  push:
    branches: [main]

jobs:
  discovery:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 2
      - uses: archyl/archyl/.github/actions/incremental-discovery@main
        with:
          api-key: ${{ secrets.ARCHYL_API_KEY }}
          project-id: ${{ vars.ARCHYL_PROJECT_ID }}

Descubrimiento completo vs incremental

	Descubrimiento completo	Descubrimiento incremental
Alcance	Repositorio completo	Solo archivos modificados
Disparador	Manual (UI/API)	Automatico (webhook o GitHub Action)
Velocidad	Minutos (depende del tamano del repo)	Segundos a minutos
Costo IA	Mayor (analiza todos los archivos)	Menor (analiza solo el diff)
Caso de uso	Configuracion inicial, refactoring mayor	Cambios de codigo diarios

Mejores Practicas

Comienza Pequeño

Para bases de código grandes:

Comienza con un solo servicio o módulo
Revisa y refina los resultados
Expande gradualmente a otras áreas

Actualizaciones Regulares

Mantén tu documentación actualizada:

Ejecuta el descubrimiento después de cambios importantes
Revisa nuevos descubrimientos pendientes
Actualiza elementos existentes según sea necesario

Combina con Manual

El Descubrimiento IA es un punto de partida:

Usa la IA para el trabajo pesado
Agrega contexto de negocio manualmente
Refina relaciones y descripciones

Solución de Problemas

El Descubrimiento Toma Mucho Tiempo

Reduce la configuración de concurrencia
Excluye directorios grandes (node_modules, vendor)
Enfócate en rutas específicas

Resultados Inexactos

Revisa y corrige sobre la marcha
La IA aprende de tus correcciones
Más contexto en comentarios de código ayuda

Descubrimiento con IA - Archyl Docs