betting-analytics/docs/README.md
rckrdmrd 094493625c 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:34 -06:00

164 lines
4.6 KiB
Markdown

---
id: "README-DOCS-BA"
title: "Documentacion - Betting Analytics"
type: "Index"
project: "betting-analytics"
version: "1.0.0"
status: "Active"
created_date: "2025-12-05"
updated_date: "2026-01-04"
---
# Documentacion - Betting Analytics
**Proyecto:** Betting Analytics
**Version:** 0.1.0
**Estado:** Planificacion
**Sistema:** NEXUS v3.4 + SIMCO + SCRUM
---
## Acerca del Proyecto
**Betting Analytics** es una plataforma de analisis de apuestas deportivas que combina:
- **Ingestion de datos** en tiempo real
- **Analytics avanzado** con metricas estadisticas
- **Modelos predictivos** basados en Machine Learning
- **Dashboard interactivo** para visualizacion
### Stack Tecnologico
| Componente | Tecnologia |
|------------|------------|
| Backend | NestJS + TypeORM |
| Frontend | React + Vite |
| ML Engine | Python + FastAPI |
| Database | PostgreSQL |
| Container | Docker |
---
## Estructura de Documentacion
| Carpeta | Contenido | Estado |
|---------|-----------|--------|
| [00-vision-general/](./00-vision-general/) | Vision, arquitectura, stack | 3 docs |
| [01-fase-alcance-inicial/](./01-fase-alcance-inicial/) | EPICs del MVP | Planificada |
| [04-fase-backlog/](./04-fase-backlog/) | DoR, DoD, backlog | 2 docs |
| [90-transversal/](./90-transversal/) | Inventarios, transversal | Pendiente |
| [95-guias-desarrollo/](./95-guias-desarrollo/) | Guias para devs | Pendiente |
| [96-quick-reference/](./96-quick-reference/) | Cheatsheets | Pendiente |
| [97-adr/](./97-adr/) | Decisiones arquitectura | 1 ADR |
| [planning/](./planning/) | Board, config, sprints | Activo |
| [archivados/](./archivados/) | Historicos | - |
---
## Documentos Clave
### Para Entender el Proyecto
1. **[Vision del Producto](./00-vision-general/VISION-PRODUCTO.md)** - Objetivos, usuarios, propuesta de valor
2. **[Arquitectura General](./00-vision-general/ARQUITECTURA-GENERAL.md)** - Componentes, flujos, modelo de datos
3. **[Stack Tecnologico](./00-vision-general/STACK-TECNOLOGICO.md)** - Tecnologias y dependencias
### Para Trabajar en el Proyecto
1. **[AGENTS.md](../AGENTS.md)** - Guia para agentes IA
2. **[Board.md](./planning/Board.md)** - Tablero Kanban activo
3. **[Definition of Ready](./04-fase-backlog/DEFINITION-OF-READY.md)** - Criterios para items "Ready"
4. **[Definition of Done](./04-fase-backlog/DEFINITION-OF-DONE.md)** - Criterios para items "Done"
### Decisiones Arquitectonicas
1. **[ADR-001: Stack Tecnologico](./97-adr/ADR-001-stack-tecnologico.md)** - Eleccion de tecnologias
---
## Navegacion
- **Mapa Completo:** [_MAP.md](./_MAP.md)
- **Configuracion:** [planning/config.yml](./planning/config.yml)
- **Board Activo:** [planning/Board.md](./planning/Board.md)
---
## EPICs del Proyecto
| ID | Nombre | Descripcion | Estado |
|----|--------|-------------|--------|
| BA-001 | Fundamentos | Estructura, auth, API base | Planificada |
| BA-002 | Ingestion de Datos | Conectores, pipelines | Backlog |
| BA-003 | Analytics Engine | Metricas, dashboard | Backlog |
| BA-004 | Predicciones ML | Modelos, backtesting | Backlog |
| BA-005 | Reportes | Visualizaciones, exportacion | Backlog |
---
## Estado del Proyecto
### Sprint Actual: Sprint-0 (Planificacion)
| Metrica | Valor |
|---------|-------|
| SP Planificados | 0 |
| SP Completados | 0 |
| Bugs Abiertos | 0 |
| US en Backlog | 3 |
### Documentacion
| Tipo | Total | Con YAML |
|------|-------|----------|
| Vision/Arquitectura | 3 | 3 (100%) |
| DoR/DoD | 2 | 2 (100%) |
| ADRs | 1 | 1 (100%) |
| _MAP.md | 4 | 4 (100%) |
---
## Codigo Fuente
| Componente | Ubicacion | Puerto |
|------------|-----------|--------|
| Backend | [apps/backend/](../apps/backend/) | 3090 |
| Frontend | [apps/frontend/](../apps/frontend/) | 80 |
| ML Engine | [apps/ml/](../apps/ml/) | 3093 |
---
## Contribuir
### Para Agentes IA
1. Leer [AGENTS.md](../AGENTS.md) antes de empezar
2. Revisar [Board.md](./planning/Board.md) para tareas disponibles
3. Seguir [DoR](./04-fase-backlog/DEFINITION-OF-READY.md) y [DoD](./04-fase-backlog/DEFINITION-OF-DONE.md)
4. Actualizar documentacion con cada cambio
### Nomenclatura
- EPICs: `BA-NNN` (ej: BA-001)
- User Stories: `US-BA-NNN` (ej: US-BA-001)
- Tasks: `TASK-BA-NNN` (ej: TASK-BA-001)
- Bugs: `BUG-BA-NNN` (ej: BUG-BA-001)
- ADRs: `ADR-NNN` (ej: ADR-001)
---
## Referencias
| Recurso | Link |
|---------|------|
| README Principal | [../README.md](../README.md) |
| AGENTS.md | [../AGENTS.md](../AGENTS.md) |
| INVENTARIO.yml | [../INVENTARIO.yml](../INVENTARIO.yml) |
| Orchestration | [../orchestration/](../orchestration/) |
---
**Ultima actualizacion:** 2026-01-04
**Mantenedor:** @Doc-Agent
**Sistema:** NEXUS v3.4 + SIMCO + SCRUM