paco/rag-service
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rag-service/docs/INDICE_DOCUMENTACION.md

9.5 KiB
Raw Blame History

Indice de documentacion

Proyecto: Workspace de tools IA para empresas
Ultima actualizacion: 2026-04-02
Ultima modificacion por: Agente tools IA para potenciar servicios empresariales

Proposito

Este documento es el mapa de la documentacion activa del workspace.

Usalo para:

  • saber que documentos existen
  • evitar documentacion duplicada
  • identificar donde registrar cambios del workspace
  • mantener limpia la documentacion de este proyecto

Protocolo rapido

  1. Lee docs/README.md antes de crear o reorganizar documentacion.
  2. Verifica aqui si el documento ya existe o si su contenido pertenece a otro archivo.
  3. Si creas un documento nuevo, anadelo aqui en la misma sesion.
  4. Si limpias documentacion heredada, actualiza este indice para reflejar el estado real.

Convencion de estructura:

  • docs/ en raiz contiene solo documentacion global del workspace.
  • cada tool o modulo independiente debe vivir en su propia carpeta raiz.
  • la documentacion propia de cada tool debe vivir dentro de su carpeta, por ejemplo RAG/docs/.

Documentos activos

README.md

Ubicacion: docs/README.md

Proposito: Reglas base para agentes y criterios de trabajo del workspace.

Cuando leerlo:

  • al empezar a trabajar en este workspace
  • antes de crear o modificar documentacion

Cuando actualizarlo:

  • si cambian las reglas del workspace
  • si se incorporan nuevas normas de documentacion o trabajo

INDICE_DOCUMENTACION.md

Ubicacion: docs/INDICE_DOCUMENTACION.md

Proposito: Inventario maestro de la documentacion vigente.

Cuando leerlo:

  • antes de crear un nuevo documento
  • al revisar estructura documental del workspace

Cuando actualizarlo:

  • cuando se crea, elimina o renombra un documento en docs/

HISTORIAL_SESIONES.md

Ubicacion: docs/HISTORIAL_SESIONES.md

Proposito: Registro de agentes y sesiones de trabajo de este workspace.

Cuando leerlo:

  • al identificar un agente
  • al revisar continuidad del trabajo anterior

Cuando actualizarlo:

  • al registrar una nueva sesion relevante
  • al dar de alta o ajustar un agente activo

PENDIENTES_GENERALES.md

Ubicacion: docs/PENDIENTES_GENERALES.md

Proposito: Backlog principal de tools, experimentos, investigaciones e integraciones del workspace.

Cuando leerlo:

  • al decidir en que trabajar a continuacion
  • al revisar prioridades del workspace

Cuando actualizarlo:

  • cuando aparece una nueva linea de trabajo
  • cuando cambia el enfoque o estado de una iniciativa

TASK.md

Ubicacion: docs/TASK.md

Proposito: Descomponer lineas de trabajo amplias en bloques de analisis, decisiones y acuerdos para avanzar sin dejar puntos importantes fuera.

Cuando leerlo:

  • cuando una linea de trabajo requiera varias conversaciones o decisiones encadenadas
  • al continuar una planificacion tecnica ya iniciada

Cuando actualizarlo:

  • cuando se abra una nueva task de analisis relevante
  • cuando cambien los puntos a convenir de una task activa

ACCESOS_INFRAESTRUCTURA_LOCAL.md

Ubicacion: docs/ACCESOS_INFRAESTRUCTURA_LOCAL.md

Proposito: Registrar accesos temporales y datos de infraestructura necesarios para auditoria, despliegue y revision operativa del workspace.

Cuando leerlo:

  • al necesitar acceder al VPS, EasyPanel o servicios relacionados
  • al revisar como estan montados servicios de infraestructura como webfetch o qdrant

Cuando actualizarlo:

  • cuando se añadan o cambien accesos de infraestructura
  • cuando se incorporen nuevos entornos o servicios relevantes

RAG/docs/SISTEMA_RAG_BASE.md

Ubicacion: RAG/docs/SISTEMA_RAG_BASE.md

Proposito: Documento marco del sistema RAG base reutilizable que se quiere construir para este workspace y para futuros proyectos.

Cuando leerlo:

  • al iniciar el trabajo sobre la linea RAG
  • al necesitar recordar objetivos, alcance y enfoque del sistema

Cuando actualizarlo:

  • cuando cambie la vision del sistema RAG
  • cuando se definan o ajusten objetivos clave del diseño base

RAG/docs/INGESTA.md

Ubicacion: RAG/docs/INGESTA.md

Proposito: Definir el modulo de ingesta del sistema RAG, su alcance, responsabilidades y preparacion para futuras actualizaciones.

Cuando leerlo:

  • al diseñar la entrada de conocimiento al RAG
  • al decidir como se incorporan y registran las fuentes

Cuando actualizarlo:

  • cuando cambie el alcance de la ingesta
  • cuando se acuerden metadatos, tipos de fuente o comportamiento base

RAG/docs/PROCESADO.md

Ubicacion: RAG/docs/PROCESADO.md

Proposito: Definir el modulo de procesado del RAG, especialmente la preparacion del contenido y la estrategia de chunking.

Cuando leerlo:

  • al definir como se transforma el contenido ingerido antes de indexarlo
  • al trabajar decisiones sobre chunking y estructura recuperable

Cuando actualizarlo:

  • cuando se acuerde o cambie la estrategia de chunking
  • cuando se amplie el tratamiento por tipo de documento o fuente

RAG/docs/BITACORA_DISENO_RAG.md

Ubicacion: RAG/docs/BITACORA_DISENO_RAG.md

Proposito: Mantener una vision panoramica del camino de diseño del RAG, incluyendo decisiones, razonamiento, contexto y opciones abiertas.

Cuando leerlo:

  • al retomar la conversacion de diseño del RAG
  • al necesitar entender por que se eligio una direccion concreta
  • al querer ver la vision general que da sentido al resto de documentos del modulo

Cuando actualizarlo:

  • cuando se cierre una decision relevante de diseño
  • cuando aparezca un cambio de rumbo, matiz importante u opcion abierta que merezca conservarse

RAG/docs/SALIDA.md

Ubicacion: RAG/docs/SALIDA.md

Proposito: Definir la salida del sistema RAG, especialmente la recuperacion de contexto y la estructura del retrieve inicial.

Cuando leerlo:

  • al diseñar como consumiran el RAG agentes, apps o herramientas
  • al revisar que debe devolver retrieve y como debe servir de contexto de arranque

Cuando actualizarlo:

  • cuando cambie la estructura de salida del RAG
  • cuando se ajusten los modos de retrieve, answer o sintesis

RAG/docs/STACK_TECNICO_V1.md

Ubicacion: RAG/docs/STACK_TECNICO_V1.md

Proposito: Documentar el stack tecnico minimo acordado para construir la primera version funcional del RAG.

Cuando leerlo:

  • al iniciar la implementacion tecnica del RAG
  • al revisar decisiones de backend, vector store, parsing y forma de acceso

Cuando actualizarlo:

  • cuando cambie alguna decision tecnica base del stack
  • cuando se cierre o cambie el proveedor inicial de embeddings

RAG/docs/DESPLIEGUE_EASYPANEL.md

Ubicacion: RAG/docs/DESPLIEGUE_EASYPANEL.md

Proposito: Documentar el patron de despliegue del modulo RAG en EasyPanel tomando como referencia los servicios ya montados en ia_servicios.

Cuando leerlo:

  • al preparar el despliegue de RAG en VPS2
  • al revisar como conectarlo correctamente con qdrant y el proyecto ia_servicios

Cuando actualizarlo:

  • cuando cambie el patron de despliegue en EasyPanel
  • cuando el servicio RAG quede finalmente publicado y probado en el VPS

RAG/docs/DUDAS_DESPLIEGUE_WEBFETCH_VPS2.md

Ubicacion: RAG/docs/DUDAS_DESPLIEGUE_WEBFETCH_VPS2.md

Proposito: Recoger dudas concretas sobre como se desplego webfetch en VPS2 para reutilizar el patron correcto al publicar RAG.

Cuando leerlo:

  • al pedir informacion a otro agente o compañero sobre el despliegue actual de webfetch
  • al preparar el despliegue de RAG siguiendo el patron de ia_servicios

Cuando actualizarlo:

  • cuando se reciban respuestas sobre el despliegue de webfetch
  • cuando las dudas queden resueltas y sirvan para desplegar RAG

RAG/docs/API_RAG.md

Ubicacion: RAG/docs/API_RAG.md

Proposito: Documentar de forma practica la API del servicio RAG, con endpoints, payloads y ejemplos listos para conectar desde n8n, agentes o aplicaciones.

Cuando leerlo:

  • al integrar el RAG desde n8n o cualquier otro cliente HTTP
  • al necesitar ejemplos listos de health, ingest, retrieve y answer

Cuando actualizarlo:

  • cuando cambie algun endpoint o payload del servicio
  • cuando se añadan nuevos modos o patrones de integracion

RAG/docs/PLAYGROUND.md

Ubicacion: RAG/docs/PLAYGROUND.md

Proposito: Documentar la tecnologia, ubicacion y utilidad del playground interno del RAG para pruebas y evaluacion.

Cuando leerlo:

  • al querer probar el RAG con interfaz web interna
  • al revisar por que se eligio esta forma de playground y no otra

Cuando actualizarlo:

  • cuando cambie la interfaz de prueba
  • cuando el playground se amplie o se conecte tambien por MCP

sesion_actual_opencode.md

Ubicacion: docs/sesion_actual_opencode.md

Proposito: Instruccion universal para detectar la sesion activa de OpenCode del workspace actual.

Cuando leerlo:

  • al necesitar identificar session_id, titulo y directorio de la sesion actual

Cuando actualizarlo:

  • solo si el usuario lo pide expresamente o cambia el mecanismo canonico de deteccion

Estado actual de la documentacion

  • La documentacion global del workspace esta concentrada en docs/.
  • La documentacion especifica de cada tool debe vivir dentro de su propio modulo raiz.
  • Se ha eliminado el arrastre documental de proyectos anteriores en los archivos base.
  • Cualquier documento nuevo debe responder al objetivo de tools IA para empresas.

Estadistica global

Total de documentos indexados: 17