rckrdmrd/erp-construccion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
erp-construccion/docs/README.md

9.5 KiB
Raw Permalink Blame History

ERP Construccion - Documentacion

Proyecto: Sistema de Administracion de Obra e INFONAVIT Version: 3.0.0 Fecha: 2025-12-05 Alineado con: ERP Core (erp-core) - GAMILIT v4.0

Introduccion

Sistema ERP especializado para la industria de construccion de vivienda, con integracion INFONAVIT. El proyecto extiende erp-core reutilizando el 61% de sus componentes y extendiendo funcionalidades especificas del dominio.

Metricas del Proyecto

Metrica Valor
Modulos 18
Requerimientos (RF) 79
Especificaciones (ET) 78
User Stories (US) 139
Story Points ~650 SP
ADRs 12
Archivos Markdown 407+
Reutilizacion GAMILIT 61%

Estructura de Documentacion

docs/
+-- README.md                            # Este archivo
+-- ESTRUCTURA-COMPLETA.md               # Estructura detallada de modulos
+-- RLS-POLICIES-TODOS-LOS-MODULOS.md    # Politicas de seguridad por modulo
|
+-- 00-overview/                         # Vision general
|   +-- MVP-APP.md                       # Definicion del MVP
|   +-- ARQUITECTURA-SAAS.md             # Arquitectura SaaS multi-tenant
|   +-- GLOSARIO.md                      # Terminos de construccion
|
+-- 01-analisis-referencias/             # Analisis de sistemas externos
|   +-- README.md
|   +-- MAPEO-MAI-TO-MGN.md              # Mapeo construccion -> erp-core (61%)
|   +-- odoo/
|   +-- gamilit/
|   +-- erp-generico/
|
+-- 02-definicion-modulos/               # Modulos MAI + MAE (18 modulos)
|   +-- _MAP.md                          # Indice maestro de modulos
|   +-- MAI-001-fundamentos/             # Fase 1
|   +-- MAI-002-proyectos-estructura/
|   +-- ...
|   +-- MAI-018-preconstruccion-licitaciones/
|   +-- MAE-014-finanzas-controlling/    # Fase 2
|   +-- MAE-015-activos-maquinaria/
|   +-- MAE-016-gestion-documental/
|
+-- 03-requerimientos/                   # Indice consolidado de RF
|   +-- README.md                        # 79 RF indexados
|
+-- 04-modelado/                         # Modelado de datos
|   +-- domain-models/                   # 6 contextos de dominio
|   +-- database-design/                 # Schemas DDL (11+)
|       +-- schemas/
|       +-- trazabilidad/
|
+-- 05-user-stories/                     # Indice consolidado de US
|   +-- README.md                        # 139 US indexadas
|
+-- 06-frontend-specs/                   # Especificaciones Frontend
|
+-- 06-test-plans/                       # Planes de prueba
|
+-- 07-devops/                           # DevOps y deployment
|
+-- 08-epicas/                           # Epicas consolidadas
|   +-- README.md
|   +-- EPIC-MAI-001-fundamentos.md
|   +-- EPIC-MAI-002-proyectos.md
|   +-- ...
|
+-- 90-transversal/                      # Documentacion transversal
|
+-- 97-adr/                              # Architecture Decision Records
    +-- README.md
    +-- ADR-001 a ADR-012

Modulos del Sistema

Fase 1: Alcance Inicial (14 modulos, ~500 SP)

Codigo Modulo RF ET US SP Reutilizacion
MAI-001 Fundamentos 3 3 8 50 100% Generico
MAI-002 Proyectos y Estructura 4 4 9 55 40% Generico
MAI-003 Presupuestos y Costos 4 4 8 60 0% Especifico
MAI-004 Compras e Inventarios 4 4 8 50 80% Generico
MAI-005 Control de Obra 4 4 8 60 0% Especifico
MAI-006 Reportes y Analytics 4 4 8 40 60% Generico
MAI-007 RRHH y Asistencias 6 6 8 45 50% Generico
MAI-008 Estimaciones 5 5 8 50 20% Generico
MAI-009 Calidad y Postventa 5 5 8 40 10% Generico
MAI-010 CRM Derechohabientes 5 5 8 45 40% Generico
MAI-011 INFONAVIT 5 5 8 45 0% Especifico
MAI-012 Contratos 5 5 8 45 20% Generico
MAI-013 Administracion 5 5 8 40 80% Generico
MAI-018 Preconstruccion 5 5 8 45 10% Generico

Subtotal Fase 1: 64 RF | 64 ET | 113 US | ~670 SP

Fase 2: Enterprise (3 modulos, 210 SP)

Codigo Modulo RF ET US SP Reutilizacion
MAE-014 Finanzas y Controlling 5 5 11 80 70% Generico
MAE-015 Activos y Maquinaria 5 5 8 70 30% Generico
MAE-016 Gestion Documental 5 5 7 60 50% Generico

Subtotal Fase 2: 15 RF | 15 ET | 26 US | 210 SP

Fase 3: Avanzada (1 modulo, pendiente)

Codigo Modulo Estado
MAA-017 Seguridad HSE Por documentar

Decisiones Arquitectonicas (ADRs)

ADR Titulo Estado
ADR-001 Stack Tecnologico Aceptada
ADR-002 Arquitectura Modular Aceptada
ADR-003 Multi-Tenancy Aceptada
ADR-004 Sistema SSOT Aceptada
ADR-005 Path Aliases Aceptada
ADR-006 RBAC Aceptada
ADR-007 Database Design Aceptada
ADR-008 API Design Aceptada
ADR-009 Frontend Architecture Aceptada
ADR-010 Testing Strategy Aceptada
ADR-011 Database Clean Load Aceptada
ADR-012 Trazabilidad Completa Aceptada

Indices Consolidados

Indice Ubicacion Contenido
Requerimientos 03-requerimientos/README.md 79 RF indexados
User Stories 05-user-stories/README.md 139 US indexadas
Modulos 02-definicion-modulos/_MAP.md 18 modulos
Domain Models 04-modelado/domain-models/README.md 6 contextos
Database Schemas 04-modelado/database-design/schemas/ 11+ schemas

Alineacion con ERP Core (GAMILIT)

Este proyecto esta alineado con erp-core para maximizar reutilizacion:

Metrica Valor
Reutilizacion total 61%
Componentes genericos 88 de 138
Componentes especificos 50 de 138

Por Capa

Capa Reutilizacion Detalles
Infraestructura 90% Auth JWT, RBAC, Multi-tenancy, RLS
Backend 60-80% Patrones, servicios base
Frontend 50-70% Componentes UI, hooks, stores
Database 70% Schemas modulares, funciones
API Design 100% RESTful patterns, DTOs

Ver MAPEO-MAI-TO-MGN.md para detalles.

Documentacion Tecnica (Desarrolladores)

Documento Descripcion
ARCHITECTURE.md Arquitectura tecnica, patrones, multi-tenant
CONTRIBUTING.md Guia de contribucion, convenciones, Git
api/openapi.yaml Especificacion OpenAPI 3.0.3
backend/API-REFERENCE.md Referencia de endpoints con ejemplos
backend/MODULES.md Documentacion de modulos backend

Documentos Clave (Funcionales)

Documento Descripcion
ESTRUCTURA-COMPLETA.md Estructura detallada de modulos
ARQUITECTURA-SAAS.md Arquitectura SaaS multi-tenant
MVP-APP.md Definicion del MVP
GLOSARIO.md Terminos de construccion
RLS-POLICIES-TODOS-LOS-MODULOS.md Politicas de seguridad

Estado de Completitud

Documentacion

  • RF documentados para todos los modulos (79/79)
  • ET documentadas para todos los modulos (78/78)
  • US documentadas con criterios de aceptacion (139/139)
  • Indice consolidado de RF
  • Indice consolidado de US
  • ADRs documentados (12/12)
  • Domain models definidos (6/6)
  • Database schemas DDL (11+)
  • TRACEABILITY.yml por modulo (post-implementacion)
  • TEST-PLAN.md por modulo (post-implementacion)

Implementacion

  • Fase 1: En progreso (35%)
  • Fase 2: Pendiente
  • Fase 3: Pendiente

Proximos Pasos

  1. Documentar RF para todos los modulos COMPLETADO
  2. Crear ET para todos los modulos COMPLETADO
  3. Definir US con criterios de aceptacion COMPLETADO
  4. Consolidar indices RF y US COMPLETADO
  5. Iniciar implementacion Sprint 0
  6. Crear TRACEABILITY.yml post-implementacion

Referencias

Changelog

v3.0.0 (2025-12-05)

  • Indices consolidados RF y US creados
  • Metricas actualizadas
  • Alineacion con GAMILIT v4.0

v2.0.0 (2025-11-24)

  • Agregados 12 ADRs alineados con ERP Core
  • Creada estructura 01-analisis-referencias/
  • Creado MAPEO-MAI-TO-MGN.md
  • Plan de retroalimentacion iniciado

v1.1.0 (2025-11-17)

  • Estructura inicial de 18 modulos
  • Documentacion de Fase 1

Ultima actualizacion: 2025-12-12 Responsable: Requirements-Analyst