rag-service/docs/README.md
2026-04-05 17:49:35 +02:00

75 lines
2.4 KiB
Markdown

# README para agentes del workspace
## Proyecto: Workspace de tools IA para empresas
Lee este archivo antes de crear documentos, editar documentacion o registrar sesiones.
---
## Objetivo del workspace
En este workspace desarrollamos tools, herramientas, skills, integraciones y componentes reutilizables para potenciar implementaciones de IA en empresas.
Esto incluye, entre otros:
- sistemas RAG
- servidores o estructuras MCP
- integraciones con servicios externos
- herramientas reutilizables para otros servicios de IA
- pruebas tecnicas, experimentos e investigaciones aplicadas
---
## Documentos base
Consulta siempre estos documentos:
1. `docs/INDICE_DOCUMENTACION.md`
2. `docs/README.md`
3. `docs/HISTORIAL_SESIONES.md`
4. `docs/PENDIENTES_GENERALES.md`
5. `docs/sesion_actual_opencode.md`
---
## Reglas de documentacion
1. Toda la documentacion del workspace va en `docs/`.
2. Antes de crear un documento nuevo, revisa `docs/INDICE_DOCUMENTACION.md` para evitar duplicados.
3. Si creas un documento nuevo, indexalo en `docs/INDICE_DOCUMENTACION.md` en la misma sesion.
4. Si haces un cambio relevante en el workspace, revisa si hay que actualizar `docs/PENDIENTES_GENERALES.md` o `docs/HISTORIAL_SESIONES.md`.
5. `docs/sesion_actual_opencode.md` es una instruccion universal del workspace y no debe modificarse salvo peticion explicita del usuario.
---
## Identificacion del agente
Si el usuario pide identificacion, revisa `docs/HISTORIAL_SESIONES.md` y responde con:
```text
Soy el [Nombre del Agente].
Trabajo en el proyecto: [Nombre del Proyecto].
Mi Conversation ID es: [valor disponible o N/D].
Me encargo de: [responsabilidad].
```
En este entorno OpenCode puede no exponer `Conversation ID`, por lo que puede usarse `session_id` del workspace como referencia operativa cuando aplique.
---
## Registro de sesiones
Al finalizar una sesion de trabajo relevante:
1. Actualiza `docs/HISTORIAL_SESIONES.md`.
2. Registra el agente, modelo y trabajo realizado.
3. Incluye `session_id` de OpenCode cuando sea util para identificar la sesion del workspace.
---
## Criterios de trabajo
1. Priorizar soluciones simples, reutilizables y desacopladas.
2. Pensar cada tool como pieza aprovechable por otros servicios.
3. Mantener foco en integraciones utiles para IA empresarial.
4. Evitar arrastrar documentacion de otros proyectos a este workspace.
5. Mantener la documentacion alineada con el estado real del workspace.