inmobiliaria-analytics/AGENTS.md
rckrdmrd f570727617 feat: Documentation and orchestration updates
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 05:35:40 -06:00

241 lines
5.2 KiB
Markdown

---
id: "AGENTS-IA"
title: "Guia para Agentes IA - Inmobiliaria Analytics"
type: "Agent Guide"
project: "inmobiliaria-analytics"
version: "1.0.0"
created_date: "2026-01-04"
updated_date: "2026-01-04"
---
# AGENTS.md - Inmobiliaria Analytics
Guia completa para que agentes de IA trabajen con el proyecto Inmobiliaria Analytics.
---
## Informacion del Proyecto
| Campo | Valor |
|-------|-------|
| **Nombre** | Inmobiliaria Analytics |
| **Prefijo** | IA |
| **Repositorio** | inmobiliaria-analytics |
| **Estado** | Planificado |
| **Stack** | NestJS, React, PostgreSQL, TypeORM |
---
## Estructura del Proyecto
```
inmobiliaria-analytics/
├── apps/
│ ├── backend/ # API NestJS (puerto 3101)
│ ├── frontend/ # UI React (puerto 3100)
│ └── database/ # Schemas PostgreSQL
├── docs/ # Documentacion GAMILIT
├── orchestration/ # Directivas y contexto
├── AGENTS.md # Este archivo
├── INVENTARIO.yml # Inventario del proyecto
└── .env.ports # Puertos asignados
```
---
## Puertos Asignados
| Servicio | Puerto | Protocolo |
|----------|--------|-----------|
| Frontend | 3100 | HTTP |
| Backend API | 3101 | HTTP |
| WebSocket | 3102 | WS |
| PostgreSQL | 5439 | TCP |
| Redis | 6386 | TCP |
---
## Nomenclatura
### Prefijos por Tipo de Documento
| Tipo | Prefijo | Ejemplo |
|------|---------|---------|
| EPIC | IA-NNN | IA-001-fundamentos |
| Requerimiento | RF-IA-NNN | RF-IA-001 |
| Especificacion | ET-IA-NNN | ET-IA-001 |
| Historia Usuario | US-IA-NNN | US-IA-001 |
| Tarea | TASK-NNN | TASK-001 |
| Bug | BUG-NNN | BUG-001 |
| ADR | ADR-NNN | ADR-001 |
### Categorias de US
| Prefijo | EPIC | Descripcion |
|---------|------|-------------|
| FUND | IA-001 | Fundamentos |
| PROP | IA-002 | Propiedades |
| ANA | IA-003 | Analytics |
| REP | IA-004 | Reportes |
---
## Como Trabajar con el Proyecto
### Tomar una Tarea
1. Revisar `docs/planning/Board.md` - columna "Por Hacer"
2. Leer archivo `TASK-XXX.md` correspondiente
3. Editar YAML front-matter:
```yaml
status: "In Progress"
assignee: "@NombreAgente"
```
4. Commit: `Start TASK-XXX: [descripcion]`
### Completar una Tarea
1. Verificar criterios de aceptacion cumplidos
2. Editar YAML front-matter:
```yaml
status: "Done"
completed_date: "YYYY-MM-DD"
```
3. Actualizar `Board.md` - mover a "Hecho"
4. Commit: `Complete TASK-XXX: [descripcion]`
### Reportar un Bug
1. Crear archivo `docs/planning/bugs/BUG-XXX.md`
2. Incluir YAML front-matter obligatorio:
```yaml
---
id: "BUG-XXX"
title: "Descripcion del bug"
type: "Bug"
status: "Open"
severity: "P1"
priority: "Alta"
affected_module: "Backend"
steps_to_reproduce:
- "Paso 1"
- "Paso 2"
expected_behavior: "..."
actual_behavior: "..."
created_date: "YYYY-MM-DD"
---
```
3. Agregar a `Board.md` en columna "Bugs"
---
## Archivos Importantes
| Archivo | Proposito |
|---------|-----------|
| `docs/planning/Board.md` | Tablero Kanban activo |
| `docs/planning/config.yml` | Configuracion SCRUM |
| `docs/04-fase-backlog/DEFINITION-OF-READY.md` | Criterios para iniciar |
| `docs/04-fase-backlog/DEFINITION-OF-DONE.md` | Criterios para completar |
| `docs/_MAP.md` | Mapa de navegacion |
| `INVENTARIO.yml` | Inventario del proyecto |
---
## Estados Validos
### User Story
- `Backlog`: No planificada
- `To Do`: Planificada para sprint
- `In Progress`: En desarrollo
- `In Review`: En revision
- `Done`: Completada
### Task
- `To Do`: Pendiente
- `In Progress`: En desarrollo
- `Blocked`: Bloqueada
- `Done`: Completada
### Bug
- `Open`: Reportado
- `In Progress`: En investigacion
- `Fixed`: Corregido, pendiente validacion
- `Done`: Validado y cerrado
- `Won't Fix`: No se corregira
---
## Convenciones de Commits
```
<tipo>(<alcance>): <descripcion>
Tipos:
- feat: Nueva funcionalidad
- fix: Correccion de bug
- docs: Documentacion
- refactor: Refactorizacion
- test: Tests
- chore: Tareas de mantenimiento
Ejemplos:
- feat(auth): Implementar login con JWT
- fix(api): Corregir validacion de propiedades
- docs(readme): Actualizar instrucciones de setup
```
---
## Flujo de Trabajo Recomendado
```
1. CONTEXTO
- Leer AGENTS.md (este archivo)
- Revisar Board.md para estado actual
- Identificar tarea a trabajar
2. ANALISIS
- Leer documentacion relacionada (RF, ET, US)
- Revisar codigo existente
- Identificar dependencias
3. PLANEACION
- Desglosar en subtareas si es necesario
- Estimar esfuerzo
- Actualizar status a "In Progress"
4. VALIDACION
- Verificar entendimiento con DoR
- Confirmar que no hay bloqueantes
5. EJECUCION
- Implementar solucion
- Escribir tests
- Documentar cambios
6. DOCUMENTACION
- Actualizar _MAP.md si aplica
- Marcar tarea como "Done"
- Commit con mensaje descriptivo
```
---
## Contacto y Escalamiento
| Rol | Responsabilidad |
|-----|-----------------|
| @Backend-Agent | APIs, servicios, base de datos |
| @Frontend-Agent | UI, componentes, estado |
| @DevOps-Agent | CI/CD, infraestructura |
| @Tech-Lead | Decisiones arquitectonicas |
---
**Generado:** 2026-01-04
**Sistema:** NEXUS v3.4 + SIMCO + GAMILIT Standard