31b1846fea
Moved loose tasks to date folders: - 2026-01-25/: TASK-002-FRONTEND-COMPREHENSIVE-AUDIT, TASK-FRONTEND-MODULE-DOCS - 2026-01-27/: TASK-BLOCKER-001-TOKEN-REFRESH, TASK-MASTER-ANALYSIS-PLAN Moved utility files to _utils/: - ARCHIVE-INFO.md - ATOMIC-TASKS-INDEX.yml Aligns with workspace-v2 orchestration standards. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
204 lines
6.4 KiB
Markdown
204 lines
6.4 KiB
Markdown
# 01-CONTEXTO - Frontend Module Documentation
|
|
|
|
**Tarea:** TASK-2026-01-25-FRONTEND-MODULE-DOCS
|
|
**Fase CAPVED:** C - Contexto
|
|
**Fecha:** 2026-01-25
|
|
**Responsable:** Claude Opus 4.5
|
|
|
|
---
|
|
|
|
## 1. ORIGEN DE LA TAREA
|
|
|
|
Esta tarea surge como seguimiento directo de **TASK-2026-01-25-002-FRONTEND-COMPREHENSIVE-AUDIT**, específicamente del documento **INTEGRATION-PLAN.md** que identificó un gap crítico: **7 módulos frontend sin README.md + 1 README desactualizado**.
|
|
|
|
### Referencias
|
|
- **Documento origen:** `TASK-002/entregables/INTEGRATION-PLAN.md` (líneas 222-302)
|
|
- **Prioridad:** P3 (documentación de soporte)
|
|
- **Esfuerzo estimado:** 8 horas (~1 día)
|
|
- **Roadmap:** Mediano plazo (esta semana)
|
|
|
|
---
|
|
|
|
## 2. OBJETIVO
|
|
|
|
Crear documentación completa para cada módulo frontend de `trading-platform`, facilitando:
|
|
|
|
1. **Onboarding de nuevos desarrolladores** - Entender rápidamente la estructura de cada módulo
|
|
2. **Mantenibilidad** - Documentar componentes, hooks, servicios y stores de cada módulo
|
|
3. **Consistencia** - Seguir template estándar definido en INTEGRATION-PLAN
|
|
4. **Visibilidad de APIs** - Listar endpoints consumidos por cada módulo
|
|
5. **Roadmap modular** - Documentar features pendientes por módulo
|
|
|
|
---
|
|
|
|
## 3. ALCANCE
|
|
|
|
### 3.1 Módulos a Documentar
|
|
|
|
| # | Módulo | Epic | Ubicación | Acción | Prioridad |
|
|
|---|--------|------|-----------|--------|-----------|
|
|
| 1 | **auth** | OQI-001 | `apps/frontend/src/modules/auth/` | 📝 Crear README | Alta |
|
|
| 2 | **education** | OQI-002 | `apps/frontend/src/modules/education/` | 📝 Crear README | Media |
|
|
| 3 | **trading** | OQI-003 | `apps/frontend/src/modules/trading/` | 📝 Crear README | Alta |
|
|
| 4 | **investment** | OQI-004 | `apps/frontend/src/modules/investment/` | 📝 Crear README | Media |
|
|
| 5 | **payments** | OQI-005 | `apps/frontend/src/modules/payments/` | 📝 Crear README | Alta |
|
|
| 6 | **ml** | OQI-006 | `apps/frontend/src/modules/ml/` | ✏️ Actualizar README | Media |
|
|
| 7 | **assistant** | OQI-007 | `apps/frontend/src/modules/assistant/` | 📝 Crear README | Baja |
|
|
| 8 | **portfolio** | OQI-008 | `apps/frontend/src/modules/portfolio/` | 📝 Crear README | Media |
|
|
|
|
**Total:** 7 a crear + 1 a actualizar = **8 READMEs**
|
|
|
|
### 3.2 Información a Documentar por Módulo
|
|
|
|
Según el template definido en INTEGRATION-PLAN:
|
|
|
|
1. **Metadata**
|
|
- Epic asociado (OQI-XXX)
|
|
- Progreso del módulo (%)
|
|
- Responsable del equipo
|
|
|
|
2. **Descripción**
|
|
- Propósito del módulo (1-2 párrafos)
|
|
- Funcionalidades principales
|
|
|
|
3. **Componentes**
|
|
- Páginas (pages/)
|
|
- Componentes reutilizables (components/)
|
|
- Hooks personalizados (hooks/)
|
|
- Servicios (services/)
|
|
- Stores de estado (stores/)
|
|
|
|
4. **Estructura de Carpetas**
|
|
- Diagrama ASCII de la estructura
|
|
|
|
5. **APIs Consumidas**
|
|
- Tabla de endpoints (método, path, descripción)
|
|
|
|
6. **Uso Rápido**
|
|
- Ejemplo de código TypeScript/React
|
|
|
|
7. **Tests**
|
|
- Comando para ejecutar tests del módulo
|
|
|
|
8. **Roadmap**
|
|
- Features pendientes (checklist)
|
|
|
|
---
|
|
|
|
## 4. ESTRATEGIA DE EJECUCIÓN
|
|
|
|
### Fase 1: Contexto (C) ✅
|
|
- Definir alcance y objetivos
|
|
- Listar módulos a documentar
|
|
- Revisar template
|
|
|
|
### Fase 2: Análisis (A)
|
|
- Usar agente **Explore** para analizar cada módulo
|
|
- Identificar componentes, hooks, services, stores
|
|
- Determinar APIs consumidas (grep por axios, fetch, tanstack query)
|
|
- Revisar progreso de cada epic en TRACEABILITY.yml
|
|
|
|
### Fase 3: Planeación (P)
|
|
- Definir orden de creación (auth → trading → payments → otros)
|
|
- Preparar estructura de contenido para cada README
|
|
- Validar template con un README de ejemplo
|
|
|
|
### Fase 4: Validación (V)
|
|
- Verificar que todos los componentes están listados
|
|
- Confirmar que las APIs consumidas son correctas
|
|
- Validar que el formato sigue el template
|
|
|
|
### Fase 5: Ejecución (E)
|
|
- Crear 7 READMEs nuevos
|
|
- Actualizar 1 README existente (ml)
|
|
- Commit por módulo o commit único
|
|
|
|
### Fase 6: Documentación (D)
|
|
- Documentar el proceso
|
|
- Actualizar MASTER_INVENTORY.yml
|
|
- Actualizar _INDEX.yml
|
|
|
|
---
|
|
|
|
## 5. CONTEXTO TÉCNICO
|
|
|
|
### 5.1 Stack Frontend
|
|
|
|
```yaml
|
|
framework: React 18.2.0
|
|
build_tool: Vite 6.2.0
|
|
state_management: Zustand 4.4.7
|
|
data_fetching: TanStack Query 5.14.0
|
|
routing: React Router 7.1.0
|
|
styling: Tailwind CSS 4.0.11
|
|
charts: lightweight-charts 4.1.1
|
|
forms: React Hook Form 7.54.2
|
|
```
|
|
|
|
### 5.2 Estructura Modular
|
|
|
|
```
|
|
apps/frontend/src/modules/
|
|
├── auth/ # OQI-001 - Autenticación
|
|
├── education/ # OQI-002 - Módulo educativo
|
|
├── trading/ # OQI-003 - Charts y trading
|
|
├── investment/ # OQI-004 - Cuentas de inversión
|
|
├── payments/ # OQI-005 - Pagos Stripe
|
|
├── ml/ # OQI-006 - Señales ML
|
|
├── assistant/ # OQI-007 - Agente LLM
|
|
└── portfolio/ # OQI-008 - Gestión portafolio
|
|
```
|
|
|
|
Cada módulo sigue la estructura:
|
|
```
|
|
modules/{nombre}/
|
|
├── components/ # Componentes React
|
|
├── hooks/ # Custom hooks
|
|
├── services/ # API calls
|
|
├── stores/ # Zustand stores
|
|
├── types/ # TypeScript types
|
|
└── pages/ # Páginas principales
|
|
```
|
|
|
|
---
|
|
|
|
## 6. RESTRICCIONES Y CONSIDERACIONES
|
|
|
|
### 6.1 Restricciones
|
|
- ❌ NO crear documentación técnica profunda (eso está en ET specs)
|
|
- ❌ NO documentar componentes individuales en detalle (solo listar)
|
|
- ❌ NO generar código nuevo, solo documentar lo existente
|
|
- ✅ Seguir template EXACTAMENTE como está definido
|
|
|
|
### 6.2 Consideraciones
|
|
- ⚠️ El módulo `ml/` ya tiene README, solo actualizar con nuevos componentes
|
|
- ⚠️ Algunos módulos pueden no tener todas las carpetas (hooks, stores)
|
|
- ⚠️ APIs consumidas pueden estar en services/ o directamente en componentes
|
|
- ⚠️ Roadmap debe basarse en RECOMMENDATIONS.md de TASK-002
|
|
|
|
---
|
|
|
|
## 7. CRITERIOS DE ÉXITO
|
|
|
|
- ✅ 8 READMEs completos (7 nuevos + 1 actualizado)
|
|
- ✅ Todos siguen el template definido
|
|
- ✅ Información técnica es precisa (componentes, APIs existen)
|
|
- ✅ Commits realizados y pusheados
|
|
- ✅ MASTER_INVENTORY.yml actualizado
|
|
- ✅ _INDEX.yml actualizado con nueva tarea
|
|
|
|
---
|
|
|
|
## 8. PRÓXIMOS PASOS
|
|
|
|
1. **Fase A (Análisis):** Explorar cada módulo con agente Explore
|
|
2. **Fase P (Planeación):** Definir contenido específico por módulo
|
|
3. **Fase V (Validación):** Revisar un README de ejemplo
|
|
4. **Fase E (Ejecución):** Crear los 8 READMEs
|
|
5. **Fase D (Documentación):** Documentar y cerrar tarea
|
|
|
|
---
|
|
|
|
**Estado:** ✅ Fase C completada
|
|
**Siguiente fase:** A - Análisis (explorar módulos)
|