Compare commits
4 Commits
f1174723ed
...
3bccc36234
| Author | SHA1 | Date | |
|---|---|---|---|
|
3bccc36234 | ||
|
|
a9224c661a | ||
|
|
c5e33555be | ||
|
|
1f47507833 |
@ -1,142 +0,0 @@
|
||||
---
|
||||
id: "Board"
|
||||
title: "Tablero Kanban - Trading Platform (Trading Platform)"
|
||||
type: "Documentation"
|
||||
project: "trading-platform"
|
||||
version: "1.0.0"
|
||||
updated_date: "2026-01-04"
|
||||
---
|
||||
|
||||
# Tablero Kanban - Trading Platform (Trading Platform)
|
||||
|
||||
**Sprint Actual:** Sprint 1 (Fase Inicial)
|
||||
**Ultima actualizacion:** 2026-01-04
|
||||
**Velocity Objetivo:** 40 SP
|
||||
|
||||
---
|
||||
|
||||
## Resumen del Sprint
|
||||
|
||||
| Metrica | Valor |
|
||||
|---------|-------|
|
||||
| Story Points Planificados | 0 |
|
||||
| Story Points Completados | 0 |
|
||||
| Tareas Pendientes | 0 |
|
||||
| Tareas En Progreso | 0 |
|
||||
| Tareas Completadas | 0 |
|
||||
| Bugs Abiertos | 0 |
|
||||
|
||||
---
|
||||
|
||||
## Backlog
|
||||
|
||||
Items pendientes de planificacion para futuros sprints.
|
||||
|
||||
| ID | Titulo | Tipo | SP | Prioridad |
|
||||
|----|--------|------|-----|-----------|
|
||||
| - | Ver `/docs/04-fase-backlog/` | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## Por Hacer (To Do)
|
||||
|
||||
Items planificados para el sprint actual, pendientes de iniciar.
|
||||
|
||||
| ID | Titulo | Asignado | SP | Prioridad | Epic |
|
||||
|----|--------|----------|-----|-----------|------|
|
||||
| - | - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## En Progreso (In Progress)
|
||||
|
||||
Items actualmente en desarrollo.
|
||||
|
||||
| ID | Titulo | Asignado | SP | Inicio | Epic |
|
||||
|----|--------|----------|-----|--------|------|
|
||||
| - | - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## Bloqueado (Blocked)
|
||||
|
||||
Items bloqueados esperando dependencias o decision.
|
||||
|
||||
| ID | Titulo | Asignado | Bloqueado Por | Desde |
|
||||
|----|--------|----------|---------------|-------|
|
||||
| - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## En Revision (Review)
|
||||
|
||||
Items completados pendientes de validacion.
|
||||
|
||||
| ID | Titulo | Asignado | Revisor | SP |
|
||||
|----|--------|----------|---------|-----|
|
||||
| - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## Hecho (Done)
|
||||
|
||||
Items completados y validados en este sprint.
|
||||
|
||||
| ID | Titulo | Completado Por | SP | Fecha |
|
||||
|----|--------|----------------|-----|-------|
|
||||
| - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## Bugs Abiertos
|
||||
|
||||
| ID | Titulo | Severidad | Modulo | Asignado |
|
||||
|----|--------|-----------|--------|----------|
|
||||
| - | - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## Notas del Sprint
|
||||
|
||||
- **2026-01-04:** Inicializacion de infraestructura SCRUM
|
||||
- Creado AGENTS.md (guia de agentes)
|
||||
- Creado config.yml (configuracion del proyecto)
|
||||
- Creado Board.md (tablero Kanban)
|
||||
- Creadas carpetas: planning/, 04-fase-backlog/, 96-quick-reference/, archivados/
|
||||
|
||||
---
|
||||
|
||||
## Historico de Sprints
|
||||
|
||||
| Sprint | Fechas | Velocity | Completado |
|
||||
|--------|--------|----------|------------|
|
||||
| Sprint 0 | Pre-2026-01 | N/A | Desarrollo inicial |
|
||||
|
||||
---
|
||||
|
||||
## Modulos del Proyecto
|
||||
|
||||
| Epica | Nombre | US | RF | ET | Estado |
|
||||
|-------|--------|-----|-----|-----|--------|
|
||||
| OQI-001 | Fundamentos Auth | 12 | 5 | 5 | Implementado |
|
||||
| OQI-002 | Education | 8 | 6 | 6 | Implementado |
|
||||
| OQI-003 | Trading Charts | 18 | 8 | 8 | Implementado |
|
||||
| OQI-004 | Investment Accounts | 14 | 6 | 7 | Implementado |
|
||||
| OQI-005 | Payments Stripe | 6 | 6 | 6 | Implementado |
|
||||
| OQI-006 | ML Signals | 10 | 5 | 5 | Implementado |
|
||||
| OQI-007 | LLM Agent | 10 | 6 | 6 | Implementado |
|
||||
| OQI-008 | Portfolio Manager | 12 | 7 | 7 | Implementado |
|
||||
|
||||
---
|
||||
|
||||
## Referencias
|
||||
|
||||
- **Backlog completo:** `/docs/04-fase-backlog/README.md`
|
||||
- **Configuracion:** `/docs/planning/config.yml`
|
||||
- **Guia de agentes:** `/AGENTS.md`
|
||||
- **Mapa de documentacion:** `/docs/_MAP.md`
|
||||
|
||||
---
|
||||
|
||||
**Mantenido por:** Scrum Master / Architecture Team
|
||||
**Actualizacion:** Al cambiar estado de cualquier item
|
||||
@ -1,209 +0,0 @@
|
||||
---
|
||||
id: "REESTRUCTURACION-PROGRESS"
|
||||
title: "Progreso de Reestructuracion - Trading Platform"
|
||||
type: "Documentation"
|
||||
project: "trading-platform"
|
||||
version: "1.0.0"
|
||||
updated_date: "2026-01-04"
|
||||
---
|
||||
|
||||
# Progreso de Reestructuracion - Trading Platform
|
||||
|
||||
**Fecha:** 2026-01-04
|
||||
**Estandar:** GAMILIT (SIMCO)
|
||||
|
||||
---
|
||||
|
||||
## Resumen Ejecutivo
|
||||
|
||||
Se ha realizado la reestructuracion de documentacion del proyecto trading-platform siguiendo el estandar GAMILIT.
|
||||
|
||||
---
|
||||
|
||||
## ETAPA 1: Infraestructura SCRUM - COMPLETADA
|
||||
|
||||
### Archivos Creados
|
||||
|
||||
| Archivo | Estado | Descripcion |
|
||||
|---------|--------|-------------|
|
||||
| `/AGENTS.md` | Creado | Guia para agentes IA con prefijos OQI-* |
|
||||
| `/docs/planning/Board.md` | Creado | Tablero Kanban |
|
||||
| `/docs/planning/config.yml` | Creado | Configuracion del proyecto |
|
||||
| `/docs/04-fase-backlog/README.md` | Creado | Indice del backlog |
|
||||
| `/docs/04-fase-backlog/DEFINITION-OF-READY.md` | Creado | Criterios DoR |
|
||||
| `/docs/04-fase-backlog/DEFINITION-OF-DONE.md` | Creado | Criterios DoD |
|
||||
|
||||
### Carpetas Creadas
|
||||
|
||||
- `/docs/planning/tasks/`
|
||||
- `/docs/planning/bugs/`
|
||||
- `/docs/04-fase-backlog/`
|
||||
- `/docs/96-quick-reference/`
|
||||
- `/docs/archivados/`
|
||||
|
||||
---
|
||||
|
||||
## ETAPA 2: YAML Front-Matter - EN PROGRESO
|
||||
|
||||
### Modulos Completados
|
||||
|
||||
| Modulo | US | RF | ET | Total | Estado |
|
||||
|--------|-----|-----|-----|-------|--------|
|
||||
| OQI-001 (Auth) | 12 | 5 | 5 | 22 | COMPLETADO |
|
||||
| OQI-002 (Education) | 8 | 6 | 6 | 20 | COMPLETADO |
|
||||
| OQI-003 (Trading) | 18 | 7 | 0 | 25 | PARCIAL (faltan ET) |
|
||||
| OQI-004 (Investment) | 0 | 0 | 0 | 0 | PENDIENTE |
|
||||
| OQI-005 (Payments) | 0 | 0 | 0 | 0 | PENDIENTE |
|
||||
| OQI-006 (ML) | 0 | 0 | 0 | 0 | PENDIENTE |
|
||||
| OQI-007 (LLM) | 0 | 0 | 0 | 0 | PENDIENTE |
|
||||
| OQI-008 (Portfolio) | 0 | 0 | 0 | 0 | PENDIENTE |
|
||||
|
||||
**Total procesados:** ~67 archivos
|
||||
**Total pendientes:** ~120 archivos
|
||||
|
||||
---
|
||||
|
||||
## ETAPA 3: DoR/DoD - COMPLETADA
|
||||
|
||||
Los archivos de Definition of Ready y Definition of Done han sido creados basados en el estandar de gamilit.
|
||||
|
||||
---
|
||||
|
||||
## Commits Pendientes
|
||||
|
||||
Los siguientes commits deben realizarse manualmente:
|
||||
|
||||
### Commit 1: Infraestructura SCRUM
|
||||
```bash
|
||||
git add AGENTS.md docs/planning/ docs/04-fase-backlog/
|
||||
git commit -m "feat(docs): Add SCRUM infrastructure - GAMILIT standard
|
||||
|
||||
ETAPA 1 - Infraestructura SCRUM:
|
||||
- Add AGENTS.md (AI agent guide for trading-platform)
|
||||
- Create docs/planning/Board.md (Kanban board)
|
||||
- Create docs/planning/config.yml (project configuration)
|
||||
- Create docs/04-fase-backlog/ with DoR/DoD
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"
|
||||
```
|
||||
|
||||
### Commit 2: YAML Front-Matter OQI-001
|
||||
```bash
|
||||
git add docs/02-definicion-modulos/OQI-001-fundamentos-auth/
|
||||
git commit -m "feat(docs): Add YAML front-matter to OQI-001 Auth module
|
||||
|
||||
Add standardized YAML front-matter to:
|
||||
- 12 User Stories (US-AUTH-*)
|
||||
- 5 Requirements (RF-AUTH-*)
|
||||
- 5 Specifications (ET-AUTH-*)
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"
|
||||
```
|
||||
|
||||
### Commit 3: YAML Front-Matter OQI-002
|
||||
```bash
|
||||
git add docs/02-definicion-modulos/OQI-002-education/
|
||||
git commit -m "feat(docs): Add YAML front-matter to OQI-002 Education module
|
||||
|
||||
Add standardized YAML front-matter to:
|
||||
- 8 User Stories (US-EDU-*)
|
||||
- 6 Requirements (RF-EDU-*)
|
||||
- 6 Specifications (ET-EDU-*)
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"
|
||||
```
|
||||
|
||||
### Commit 4: YAML Front-Matter OQI-003
|
||||
```bash
|
||||
git add docs/02-definicion-modulos/OQI-003-trading-charts/
|
||||
git commit -m "feat(docs): Add YAML front-matter to OQI-003 Trading module
|
||||
|
||||
Add standardized YAML front-matter to:
|
||||
- 18 User Stories (US-TRD-*)
|
||||
- 7 Requirements (RF-TRD-*)
|
||||
- 1 Specification (ET-TRD-001)
|
||||
|
||||
Note: Remaining ET-TRD-* files pending
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Trabajo Pendiente
|
||||
|
||||
Para completar la reestructuracion, se deben procesar los siguientes modulos:
|
||||
|
||||
1. **OQI-003 (Trading):** Completar especificaciones tecnicas (ET-TRD-002 a ET-TRD-008)
|
||||
2. **OQI-004 (Investment):** Procesar todos los archivos US/RF/ET
|
||||
3. **OQI-005 (Payments):** Procesar todos los archivos US/RF/ET
|
||||
4. **OQI-006 (ML Signals):** Procesar todos los archivos US/RF/ET
|
||||
5. **OQI-007 (LLM Agent):** Procesar todos los archivos US/RF/ET
|
||||
6. **OQI-008 (Portfolio):** Procesar todos los archivos US/RF/ET
|
||||
|
||||
### Template YAML para User Story
|
||||
```yaml
|
||||
---
|
||||
id: "US-XXX-NNN"
|
||||
title: "Titulo de la Historia"
|
||||
type: "User Story"
|
||||
status: "Done"
|
||||
priority: "Alta"
|
||||
epic: "OQI-NNN"
|
||||
story_points: N
|
||||
created_date: "2025-12-05"
|
||||
updated_date: "2026-01-04"
|
||||
---
|
||||
```
|
||||
|
||||
### Template YAML para Requirement
|
||||
```yaml
|
||||
---
|
||||
id: "RF-XXX-NNN"
|
||||
title: "Titulo del Requerimiento"
|
||||
type: "Requirement"
|
||||
status: "Done"
|
||||
priority: "Alta"
|
||||
module: "modulo"
|
||||
epic: "OQI-NNN"
|
||||
version: "1.0"
|
||||
created_date: "2025-12-05"
|
||||
updated_date: "2026-01-04"
|
||||
---
|
||||
```
|
||||
|
||||
### Template YAML para Specification
|
||||
```yaml
|
||||
---
|
||||
id: "ET-XXX-NNN"
|
||||
title: "Titulo de la Especificacion"
|
||||
type: "Specification"
|
||||
status: "Done"
|
||||
rf_parent: "RF-XXX-NNN"
|
||||
epic: "OQI-NNN"
|
||||
version: "1.0"
|
||||
created_date: "2025-12-05"
|
||||
updated_date: "2026-01-04"
|
||||
---
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Notas
|
||||
|
||||
- El contenido existente de los archivos NO fue modificado
|
||||
- Solo se agrego YAML front-matter al inicio de cada archivo
|
||||
- Se mantiene la estructura de carpetas original (02-definicion-modulos/ con OQI-001 a OQI-008)
|
||||
|
||||
---
|
||||
|
||||
**Generado por:** Claude Opus 4.5
|
||||
**Fecha:** 2026-01-04
|
||||
@ -1,186 +0,0 @@
|
||||
# Configuracion del Sistema de Planificacion Trading Platform (Trading Platform)
|
||||
# Basado en: Estandar-SCRUM.md (Principio SIMCO)
|
||||
# Version: 1.0
|
||||
# Fecha: 2026-01-04
|
||||
|
||||
project:
|
||||
name: "Trading Platform"
|
||||
description: "Plataforma de Trading con IA - Trading Platform"
|
||||
version: "1.0.0"
|
||||
repository: "trading-platform"
|
||||
|
||||
# Estados validos para elementos de trabajo
|
||||
states:
|
||||
user_story:
|
||||
- "Backlog"
|
||||
- "To Do"
|
||||
- "In Progress"
|
||||
- "In Review"
|
||||
- "Done"
|
||||
task:
|
||||
- "To Do"
|
||||
- "In Progress"
|
||||
- "Blocked"
|
||||
- "Done"
|
||||
bug:
|
||||
- "Open"
|
||||
- "In Progress"
|
||||
- "Fixed"
|
||||
- "Done"
|
||||
- "Won't Fix"
|
||||
|
||||
# Prioridades
|
||||
priorities:
|
||||
- id: "P0"
|
||||
name: "Critico"
|
||||
description: "Bloqueante para produccion o seguridad"
|
||||
sla_hours: 4
|
||||
- id: "P1"
|
||||
name: "Alto"
|
||||
description: "Funcionalidad core, deadline cercano"
|
||||
sla_hours: 24
|
||||
- id: "P2"
|
||||
name: "Medio"
|
||||
description: "Mejoras importantes, puede esperar"
|
||||
sla_hours: 72
|
||||
- id: "P3"
|
||||
name: "Bajo"
|
||||
description: "Nice-to-have, mejoras menores"
|
||||
sla_hours: null
|
||||
|
||||
# Prefijos de nomenclatura
|
||||
naming:
|
||||
epic_prefix: "OQI"
|
||||
user_story: "US"
|
||||
task: "TASK"
|
||||
bug: "BUG"
|
||||
requirement: "RF"
|
||||
specification: "ET"
|
||||
adr: "ADR"
|
||||
|
||||
# Subcategorias de User Stories por modulo
|
||||
us_categories:
|
||||
- prefix: "AUTH"
|
||||
epic: "OQI-001"
|
||||
description: "Autenticacion"
|
||||
- prefix: "EDU"
|
||||
epic: "OQI-002"
|
||||
description: "Educacion"
|
||||
- prefix: "TRD"
|
||||
epic: "OQI-003"
|
||||
description: "Trading Charts"
|
||||
- prefix: "INV"
|
||||
epic: "OQI-004"
|
||||
description: "Investment Accounts"
|
||||
- prefix: "PAY"
|
||||
epic: "OQI-005"
|
||||
description: "Payments Stripe"
|
||||
- prefix: "ML"
|
||||
epic: "OQI-006"
|
||||
description: "ML Signals"
|
||||
- prefix: "LLM"
|
||||
epic: "OQI-007"
|
||||
description: "LLM Agent"
|
||||
- prefix: "PFM"
|
||||
epic: "OQI-008"
|
||||
description: "Portfolio Manager"
|
||||
|
||||
# Configuracion de sprints
|
||||
sprint:
|
||||
duration_days: 14
|
||||
velocity_target: 40
|
||||
current_sprint: 1
|
||||
current_phase: 1
|
||||
|
||||
# Agentes disponibles
|
||||
agents:
|
||||
- id: "@Backend-Agent"
|
||||
specialization: "Express, PostgreSQL, APIs"
|
||||
- id: "@Frontend-Agent"
|
||||
specialization: "React, TypeScript, UI/UX"
|
||||
- id: "@Database-Agent"
|
||||
specialization: "PostgreSQL, Migrations, Seeds"
|
||||
- id: "@ML-Agent"
|
||||
specialization: "Python, TensorFlow, Trading Signals"
|
||||
- id: "@Integration-Agent"
|
||||
specialization: "Testing, Validacion, CI/CD"
|
||||
- id: "@DevOps-Agent"
|
||||
specialization: "Docker, Kubernetes, Deployment"
|
||||
|
||||
# Columnas del tablero Kanban
|
||||
kanban_columns:
|
||||
- id: "backlog"
|
||||
name: "Backlog"
|
||||
description: "Items no planificados"
|
||||
- id: "todo"
|
||||
name: "Por Hacer"
|
||||
description: "Planificado para sprint actual"
|
||||
- id: "in_progress"
|
||||
name: "En Progreso"
|
||||
description: "Trabajo activo"
|
||||
- id: "blocked"
|
||||
name: "Bloqueado"
|
||||
description: "Esperando dependencias"
|
||||
- id: "review"
|
||||
name: "En Revision"
|
||||
description: "Pendiente de validacion"
|
||||
- id: "done"
|
||||
name: "Hecho"
|
||||
description: "Completado y validado"
|
||||
|
||||
# Campos requeridos por tipo de documento
|
||||
required_fields:
|
||||
user_story:
|
||||
- "id"
|
||||
- "title"
|
||||
- "status"
|
||||
- "epic"
|
||||
- "story_points"
|
||||
task:
|
||||
- "id"
|
||||
- "title"
|
||||
- "status"
|
||||
- "priority"
|
||||
bug:
|
||||
- "id"
|
||||
- "title"
|
||||
- "status"
|
||||
- "severity"
|
||||
- "affected_module"
|
||||
requirement:
|
||||
- "id"
|
||||
- "title"
|
||||
- "status"
|
||||
- "module"
|
||||
specification:
|
||||
- "id"
|
||||
- "title"
|
||||
- "status"
|
||||
- "rf_parent"
|
||||
|
||||
# Rutas importantes
|
||||
paths:
|
||||
planning: "/docs/planning/"
|
||||
tasks: "/docs/planning/tasks/"
|
||||
bugs: "/docs/planning/bugs/"
|
||||
board: "/docs/planning/Board.md"
|
||||
backlog: "/docs/04-fase-backlog/"
|
||||
modules: "/docs/02-definicion-modulos/"
|
||||
adr: "/docs/97-adr/"
|
||||
|
||||
# Metricas del proyecto
|
||||
metrics:
|
||||
total_epics: 8
|
||||
total_user_stories: 90
|
||||
total_requirements: 47
|
||||
total_specifications: 50
|
||||
compliance_target: 100
|
||||
current_compliance: 0
|
||||
|
||||
# Configuracion de validacion
|
||||
validation:
|
||||
require_yaml_frontmatter: true
|
||||
require_acceptance_criteria: true
|
||||
require_story_points: true
|
||||
max_file_lines: 400
|
||||
enforce_naming_convention: true
|
||||
@ -0,0 +1,292 @@
|
||||
# ST3.2: Documentation Reorganization Analysis
|
||||
|
||||
**Fecha:** 2026-01-26
|
||||
**Tarea:** TASK-2026-01-29-DOCUMENTATION-PURGE
|
||||
**Subtarea:** ST3.2 (4h estimadas)
|
||||
**Agente:** Claude Opus 4.5
|
||||
|
||||
---
|
||||
|
||||
## Resumen Ejecutivo
|
||||
|
||||
Análisis de estructura docs/ para identificar archivos redundantes, obsoletos, o desorganizados que requieren reorganización post-integración de ST1-ST2.
|
||||
|
||||
---
|
||||
|
||||
## Hallazgos
|
||||
|
||||
### 1. Archivos Sueltos en docs/ (Potencialmente Redundantes)
|
||||
|
||||
| Archivo | Líneas | Fecha | Estado | Acción Recomendada |
|
||||
|---------|--------|-------|--------|-------------------|
|
||||
| **API.md** | 636 | 2026-01-04 | ⚠️ Posiblemente redundante | Comparar con swagger.yml (ST2.3), consolidar/archivar |
|
||||
| **ARCHITECTURE.md** | 576 | 2026-01-04 | ⚠️ Posiblemente redundante | Verificar vs docs/01-arquitectura/, consolidar |
|
||||
| **SECURITY.md** | 822 | 2026-01-04 | ✅ Legítimo | Mover a docs/90-transversal/security/ |
|
||||
| **_MAP.md** | 455 | 2026-01-07 | ⚠️ Desactualizado | Actualizar fecha y contenido |
|
||||
| **README.md** | 280 | 2026-01-04 | ✅ Legítimo | Mantener (punto de entrada) |
|
||||
|
||||
### 2. Carpetas Sueltas (Posiblemente Obsoletas)
|
||||
|
||||
#### docs/planning/ (Contenido obsoleto)
|
||||
```
|
||||
planning/
|
||||
├── Board.md # 2026-01-04 - Tablero Kanban obsoleto
|
||||
├── config.yml # 2026-01-04 - Config antigua
|
||||
└── REESTRUCTURACION-PROGRESS.md # 2026-01-04 - Proceso antiguo GAMILIT
|
||||
```
|
||||
|
||||
**Análisis:** Documenta "reestructuración GAMILIT" de enero 2026. Contenido obsoleto.
|
||||
|
||||
**Acción:** ❌ **ELIMINAR** (archivar en docs/99-analisis/obsoletos/ si hay valor histórico)
|
||||
|
||||
---
|
||||
|
||||
#### docs/architecture/ (Contenido desorganizado)
|
||||
```
|
||||
architecture/
|
||||
└── EA-BRIDGE-ARCHITECTURE.md # 14,401 líneas - MT4 Expert Advisor bridge
|
||||
```
|
||||
|
||||
**Análisis:** Arquitectura MT4 que debería estar en docs/01-arquitectura/
|
||||
|
||||
**Acción:** ➡️ **MOVER** a docs/01-arquitectura/ARQUITECTURA-EA-BRIDGE-MT4.md
|
||||
|
||||
---
|
||||
|
||||
#### docs/api-contracts/ (Contenido desorganizado)
|
||||
```
|
||||
api-contracts/
|
||||
└── SERVICE-INTEGRATION.md # 13,103 líneas - Integración servicios
|
||||
```
|
||||
|
||||
**Análisis:** Documenta integración entre servicios (MCP, ML, backend).
|
||||
|
||||
**Acción:** ➡️ **MOVER** a docs/90-transversal/integraciones/INT-SERVICES-INTEGRATION.md
|
||||
|
||||
---
|
||||
|
||||
### 3. Archivos Duplicados/Redundantes
|
||||
|
||||
#### API.md vs swagger.yml
|
||||
|
||||
| Aspecto | API.md (636 líneas) | swagger.yml (1,335 líneas) |
|
||||
|---------|---------------------|----------------------------|
|
||||
| Fecha | 2026-01-04 | 2026-01-26 (ST2.3) |
|
||||
| Formato | Markdown | OpenAPI 3.0.3 |
|
||||
| Contenido | Overview puertos, auth | Especificación completa 34 endpoints |
|
||||
| Estado | ⚠️ Posiblemente desactualizado | ✅ Actualizado y completo |
|
||||
|
||||
**Decisión:**
|
||||
- swagger.yml es la fuente oficial de especificación API
|
||||
- API.md tiene valor como overview legible (puertos, conceptos)
|
||||
- **Acción:** Actualizar API.md para referenciar swagger.yml, reducir duplicación
|
||||
|
||||
---
|
||||
|
||||
#### ARCHITECTURE.md vs docs/01-arquitectura/
|
||||
|
||||
| Aspecto | ARCHITECTURE.md (576 líneas) | docs/01-arquitectura/ (múltiples archivos) |
|
||||
|---------|------------------------------|-------------------------------------------|
|
||||
| Fecha | 2026-01-04 | 2026-01-24 (actualizado) |
|
||||
| Contenido | Overview general, tech stack | Arquitecturas específicas detalladas |
|
||||
| Nivel | Alto nivel (introducción) | Detallado (implementación) |
|
||||
|
||||
**Decisión:**
|
||||
- ARCHITECTURE.md tiene valor como overview de alto nivel
|
||||
- docs/01-arquitectura/ contiene documentos especializados
|
||||
- **Acción:** Mover secciones de ARCHITECTURE.md a docs/00-vision-general/ARQUITECTURA-GENERAL.md (consolida con doc existente)
|
||||
|
||||
---
|
||||
|
||||
## Plan de Reorganización
|
||||
|
||||
### Fase 1: Archivos Temporales Obsoletos (✅ ST3.1 - Completado)
|
||||
|
||||
```bash
|
||||
rm -f nul " -u" -u
|
||||
git add -A && git commit -m "chore: Remove temporary error files"
|
||||
```
|
||||
|
||||
**Resultado:** ✅ Commit f10c31db
|
||||
|
||||
---
|
||||
|
||||
### Fase 2: Reorganizar Carpetas Sueltas
|
||||
|
||||
#### 2.1: Mover architecture/EA-BRIDGE-ARCHITECTURE.md
|
||||
|
||||
```bash
|
||||
mv docs/architecture/EA-BRIDGE-ARCHITECTURE.md \
|
||||
docs/01-arquitectura/ARQUITECTURA-EA-BRIDGE-MT4.md
|
||||
|
||||
rmdir docs/architecture/
|
||||
|
||||
git add -A && git commit -m "docs: Move EA bridge architecture to 01-arquitectura/"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 2.2: Mover api-contracts/SERVICE-INTEGRATION.md
|
||||
|
||||
```bash
|
||||
mv docs/api-contracts/SERVICE-INTEGRATION.md \
|
||||
docs/90-transversal/integraciones/INT-SERVICES-INTEGRATION.md
|
||||
|
||||
rmdir docs/api-contracts/
|
||||
|
||||
git add -A && git commit -m "docs: Move service integration to 90-transversal/integraciones/"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 2.3: Eliminar docs/planning/ (obsoleto)
|
||||
|
||||
```bash
|
||||
# Opción 1: Archivar si hay valor histórico
|
||||
mkdir -p docs/99-analisis/obsoletos/planning-2026-01-04
|
||||
mv docs/planning/* docs/99-analisis/obsoletos/planning-2026-01-04/
|
||||
|
||||
# Opción 2: Eliminar directamente
|
||||
rm -rf docs/planning/
|
||||
|
||||
git add -A && git commit -m "docs: Remove obsolete planning/ directory"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Fase 3: Consolidar Archivos Sueltos
|
||||
|
||||
#### 3.1: Consolidar ARCHITECTURE.md
|
||||
|
||||
**Acción:** Mover contenido único a docs/00-vision-general/ARQUITECTURA-GENERAL.md
|
||||
|
||||
```bash
|
||||
# Editar docs/00-vision-general/ARQUITECTURA-GENERAL.md para incorporar secciones únicas
|
||||
# Eliminar docs/ARCHITECTURE.md
|
||||
|
||||
rm docs/ARCHITECTURE.md
|
||||
git add -A && git commit -m "docs: Consolidate ARCHITECTURE.md into 00-vision-general/"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 3.2: Actualizar API.md para referenciar swagger.yml
|
||||
|
||||
**Acción:** Reducir API.md a overview con referencia a swagger.yml
|
||||
|
||||
**Ejemplo:**
|
||||
```markdown
|
||||
# API Documentation
|
||||
|
||||
**⚠️ For complete API specification, see: [swagger.yml](../apps/backend/swagger.yml)**
|
||||
|
||||
This document provides a high-level overview of the API.
|
||||
|
||||
## Base URL
|
||||
|
||||
Development: http://localhost:3080/api/v1
|
||||
|
||||
## Service Ports
|
||||
|
||||
| Service | Port | Description |
|
||||
|---------|------|-------------|
|
||||
| Backend API | 3080 | Main REST API |
|
||||
| Frontend | 3000 | React SPA |
|
||||
...
|
||||
|
||||
## Authentication
|
||||
|
||||
See [swagger.yml](../apps/backend/swagger.yml) for detailed authentication endpoints.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 3.3: Mover SECURITY.md
|
||||
|
||||
```bash
|
||||
mkdir -p docs/90-transversal/security/
|
||||
mv docs/SECURITY.md docs/90-transversal/security/SECURITY.md
|
||||
|
||||
git add -A && git commit -m "docs: Move SECURITY.md to 90-transversal/security/"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Fase 4: Actualizar _MAP.md
|
||||
|
||||
**Cambios necesarios:**
|
||||
```yaml
|
||||
Metadata:
|
||||
updated_date: "2026-01-26" # Actualizar fecha
|
||||
version: "2.2.0" # Incrementar versión
|
||||
|
||||
Métricas:
|
||||
Documentación: 98% -> 100% # Después de ST1-ST3
|
||||
Implementación: 25% -> 30% # Reflejar OQI-006, OQI-007 completados
|
||||
|
||||
Secciones nuevas:
|
||||
- API Specification (swagger.yml)
|
||||
- Endpoint Routing (ENDPOINT-ROUTING.md)
|
||||
- Type Coherence (ST1 fixes)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Estructura Final Propuesta
|
||||
|
||||
```
|
||||
docs/
|
||||
├── _MAP.md # ✅ Actualizado (ST3.4)
|
||||
├── README.md # ✅ Mantener
|
||||
│
|
||||
├── 00-vision-general/
|
||||
│ ├── ARQUITECTURA-GENERAL.md # ✅ Consolidado ARCHITECTURE.md aquí
|
||||
│ └── ...
|
||||
│
|
||||
├── 01-arquitectura/
|
||||
│ ├── ARQUITECTURA-EA-BRIDGE-MT4.md # ➡️ Movido desde architecture/
|
||||
│ └── ...
|
||||
│
|
||||
├── 02-definicion-modulos/
|
||||
│ └── OQI-*/ # ✅ Sin cambios
|
||||
│
|
||||
├── 90-transversal/
|
||||
│ ├── integraciones/
|
||||
│ │ ├── INT-SERVICES-INTEGRATION.md # ➡️ Movido desde api-contracts/
|
||||
│ │ └── ...
|
||||
│ └── security/
|
||||
│ └── SECURITY.md # ➡️ Movido desde raíz
|
||||
│
|
||||
├── 99-analisis/
|
||||
│ └── obsoletos/ # ❌ Archivos obsoletos (planning/)
|
||||
│
|
||||
└── API.md # ⚠️ Reducido, referencia swagger.yml
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Validaciones Post-Reorganización
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] Todos los archivos movidos tienen rutas actualizadas en _MAP.md
|
||||
- [ ] No quedan carpetas vacías (architecture/, api-contracts/, planning/)
|
||||
- [ ] Referencias internas actualizadas (links relativos)
|
||||
- [ ] _MAP.md refleja estructura final
|
||||
- [ ] Git: 5-7 commits lógicos separados por tipo de cambio
|
||||
|
||||
---
|
||||
|
||||
## Esfuerzo Real vs Estimado
|
||||
|
||||
| Fase | Estimado | Real | Comentarios |
|
||||
|------|----------|------|-------------|
|
||||
| ST3.1: Eliminar temporales | 0.5h | 0.25h | ✅ Completado |
|
||||
| ST3.2: Reorganizar docs/ | 4h | TBD | En progreso |
|
||||
| ST3.3: Actualizar inventarios | 1.5h | Pendiente | |
|
||||
| ST3.4: Deployment guide | 2h | Pendiente | |
|
||||
|
||||
---
|
||||
|
||||
**Total ST3 estimado:** 8h
|
||||
**Progreso:** 12.5% (ST3.1 completado)
|
||||
Loading…
Reference in New Issue
Block a user