---
id: "DOCS-README"
title: "Documentacion - Inmobiliaria Analytics"
type: "Index Document"
project: "inmobiliaria-analytics"
version: "1.0.0"
standard: "GAMILIT"
created_date: "2026-01-04"
updated_date: "2026-01-04"
---

# Documentacion - Inmobiliaria Analytics

**Proyecto:** Inmobiliaria Analytics
**Version:** 1.0.0
**Estado:** En desarrollo
**Fecha:** 2026-01-04
**Estandar:** GAMILIT (Sistema NEXUS v3.4 + SIMCO)

---

## Descripcion

Este directorio contiene toda la documentacion del proyecto **Inmobiliaria Analytics**, una plataforma de analytics para el sector inmobiliario.

La documentacion sigue el estandar **GAMILIT** basado en:
- **NEXUS v3.4**: Sistema de orquestacion
- **SIMCO**: Sistema Indexado Modular por Contexto
- **SCRUM para IA**: Metodologia adaptada para agentes de IA

---

## Inicio Rapido

### Para Agentes IA

1. Leer [AGENTS.md](../AGENTS.md) - Guia completa
2. Revisar [Board.md](./planning/Board.md) - Estado actual
3. Consultar [config.yml](./planning/config.yml) - Configuracion

### Para Desarrolladores

1. [STACK-TECNOLOGICO.md](./00-vision-general/STACK-TECNOLOGICO.md) - Stack del proyecto
2. [ARQUITECTURA-GENERAL.md](./00-vision-general/ARQUITECTURA-GENERAL.md) - Arquitectura
3. [ADR-001](./97-adr/ADR-001-stack-tecnologico.md) - Decisiones tecnicas

### Para Nuevos Miembros

1. [VISION-PRODUCTO.md](./00-vision-general/VISION-PRODUCTO.md) - Vision y objetivos
2. [DEFINITION-OF-READY.md](./04-fase-backlog/DEFINITION-OF-READY.md) - Como preparar trabajo
3. [DEFINITION-OF-DONE.md](./04-fase-backlog/DEFINITION-OF-DONE.md) - Criterios de completado

---

## Estructura de Carpetas

| Carpeta | Descripcion |
|---------|-------------|
| `00-vision-general/` | Vision del producto, arquitectura, stack |
| `01-fase-alcance-inicial/` | EPICs del MVP |
| `04-fase-backlog/` | Backlog, Definition of Ready/Done |
| `90-transversal/` | Documentacion transversal |
| `95-guias-desarrollo/` | Guias para desarrolladores |
| `96-quick-reference/` | Cheatsheets |
| `97-adr/` | Architecture Decision Records |
| `planning/` | Tablero Kanban y sprints |
| `archivados/` | Documentacion deprecada |

---

## Navegacion

Cada carpeta contiene un archivo `_MAP.md` con:
- Indice de contenidos
- Estado de cada documento
- Links de navegacion

El mapa principal esta en [_MAP.md](./_MAP.md).

---

## EPICs del Proyecto

### Fase 1: Alcance Inicial (MVP)

| EPIC | Nombre | Estado |
|------|--------|--------|
| IA-001 | [Fundamentos](./01-fase-alcance-inicial/IA-001-fundamentos/README.md) | Planned |
| IA-002 | Propiedades | Backlog |
| IA-003 | Analytics | Backlog |

### Fase 2: Extensiones

| EPIC | Nombre | Estado |
|------|--------|--------|
| IA-004 | Reportes | Backlog |
| IA-005 | Integraciones | Backlog |

---

## Stack Tecnologico

| Capa | Tecnologia |
|------|------------|
| Backend | NestJS 10.x, TypeORM, PostgreSQL 16 |
| Frontend | React 18.x, TypeScript, Vite |
| Cache | Redis 7.x |
| Infra | Docker, Traefik |

Ver detalle en [STACK-TECNOLOGICO.md](./00-vision-general/STACK-TECNOLOGICO.md).

---

## Convenciones

### Nomenclatura

| Tipo | Prefijo | Ejemplo |
|------|---------|---------|
| EPIC | IA-NNN | IA-001 |
| Requerimiento | RF-IA-NNN | RF-IA-001 |
| User Story | US-IA-NNN | US-IA-001 |
| Task | TASK-NNN | TASK-001 |
| Bug | BUG-NNN | BUG-001 |
| ADR | ADR-NNN | ADR-001 |

### YAML Front-Matter

Todos los documentos incluyen YAML front-matter con:
- `id`: Identificador unico
- `title`: Titulo del documento
- `type`: Tipo de documento
- `status`: Estado actual
- `created_date`: Fecha de creacion
- `updated_date`: Ultima actualizacion

---

## Links Utiles

| Recurso | Ubicacion |
|---------|-----------|
| Codigo Backend | `../apps/backend/` |
| Codigo Frontend | `../apps/frontend/` |
| Orchestration | `../orchestration/` |
| Puertos | `../.env.ports` |

---

## Contribuir

1. Crear branch desde `develop`
2. Seguir nomenclatura del proyecto
3. Incluir YAML front-matter en documentos
4. Actualizar _MAP.md correspondiente
5. Crear Pull Request

---

## Soporte

Para dudas sobre documentacion, consultar:
- [AGENTS.md](../AGENTS.md) - Guia para agentes
- [config.yml](./planning/config.yml) - Configuracion

---

**Directiva Aplicable:** GAMILIT Standard
**Sistema:** NEXUS v3.4 + SIMCO
**Ultima actualizacion:** 2026-01-04