docs

📚 Documentación del Proyecto Senselab Core API

Última actualización: Abril 2026 — v5.0.1

Este directorio contiene toda la documentación organizada del proyecto.

📁 Estructura

docs/
├── api/           # Documentación de la API (controllers, models, policies)
├── archive/       # Documentación histórica (fases completadas, sprints, sesiones)
├── database/      # Configuración y esquema de base de datos
├── diagrams/      # 📊 Diagramas de arquitectura, ERDs, flujos, benchmarks (Mermaid)
├── guides/        # Guías de instalación, docker, testing, refactorización
├── hacienda/      # Integración con Ministerio de Hacienda CR (normativa + diagramas)
├── images/badges/ # 🏆 Badges SVG de auditoría y métricas
├── sprints/       # Documentación de sprints y resúmenes ejecutivos
├── examples.http  # Ejemplos REST Client para probar endpoints
└── *.md           # Documentos de referencia activa

📖 Documentos Principales

Archivo	Descripción
README.md	Documentación principal del proyecto
ESTADO_ACTUAL_PROYECTO.md	Estado actual con métricas reales
CHANGELOG.md	Historial de cambios
SECURITY.md	Políticas de seguridad

📘 Curso y Glosario

Archivo	Descripción
Curso Completo: De Cero a Experto	Curso autodidacta integral — arquitectura, módulos, seguridad, testing, despliegue, IA, facturación electrónica y roadmap
Glosario Completo de Terminología	Referencia exhaustiva de toda la terminología: modelos, servicios, DTOs, traits, eventos, jobs, observers, config y más

� Diagramas de Arquitectura (NUEVO)

Diagrama	Tipo	Audiencia
Arquitectura Multi-Tenant	Topología	Desarrolladores, DevOps
Flujo Facturación Electrónica	Secuencia	Desarrolladores, QA
Ciclo de Vida del Dato con IA	Flujo	Ejecutivos, Ventas
Precisión de Servicios IA	Gráficos	Ejecutivos, Ventas
ERD Módulo Contable	ERD	Desarrolladores
ERD Módulo Logística	ERD	Desarrolladores
Matriz RBAC Seguridad	Tabla + Grafo	Admins, Seguridad
Benchmarks Rendimiento Redis	XY Chart	Ventas, DevOps

Ver el índice completo de diagramas con resumen ejecutivo y badges.

�📄 Documentos de Referencia Activa (este directorio)

Archivo	Descripción
IA_FUNCIONALIDADES.md	Módulo de Inteligencia Artificial (10 servicios, 32 endpoints)
VALORACION_COMERCIAL_Y_PRICING.md	💰 Valoración comercial, estudio de mercado y estrategia de pricing (4 tiers)
KNOWN_WARNINGS.md	Warnings conocidos y aceptados (PHPStan/SonarQube)
PENDIENTES_PROYECTO.md	Lista de pendientes y TODOs
MAPA_ESTRUCTURAL_API.txt	Mapa estructural de la arquitectura
release_checklist.md	Checklist pre-release para producción
examples.http	Ejemplos REST Client para probar endpoints

📊 Estado Actual (Abril 2026 — v5.0.1)

Métrica	Valor
Controladores API	96
Modelos Eloquent	98
Tests	959+ passing (154 archivos)
Servicios	67 (10 IA + 9 Hacienda + 48 core)
FormRequests	175
Resources	81
Policies	80
Migraciones	103
DTOs	63 (~65% cobertura)
PHPStan	Level 8 — 0 errores
Auditoría	9.2/10
Hacienda v4.4	38/38 compliance (100%)
Rutas	16 archivos particionados en routes/api/
Fases completadas	1-22 ✅ (Roadmap 100%)

🚀 Guías Rápidas

Instalación

• Installation Guide - Instalación completa
• Docker Guide - Configuración Docker
• Docker Quickstart - Inicio rápido con Docker
• Instalación Docker Resumen - Resumen rápido

Desarrollo

• Contributing - Guía de contribución
• Colaboradores README - Onboarding para colaboradores
• Testing Guide - Cómo ejecutar tests
• Guía Datos Testeo - Datos de prueba
• Como Probar API - Probar endpoints
• Setup VS Code - Extensiones recomendadas
• Generador de Módulos - Crear nuevos módulos ERP
• Refactorización Controladores - Patrón Service Layer

API

• API Documentation - Endpoints completos
• Controllers Summary - Resumen de controllers
• Controllers Complete - Detalle completo
• Models Relations - Relaciones de modelos
• FormRequests Guide - Validación
• Policies Guide - Autorización RBAC

Inteligencia Artificial 🤖

• IA Funcionalidades - Documentación completa
• 10 Servicios: OCR, Chatbot, Predicciones, Anomalías, Contenido, CABYS, Credit Scoring
• 32 Endpoints bajo /api/ai/

Hacienda Costa Rica

• Facturación Electrónica Setup - Configuración FE
• Facturación Electrónica API - Endpoints FE
• Análisis v4.4 - Análisis completo
• Plan Implementación v4.4 - Plan detallado

Base de Datos

• Database README - Esquema de BD
• Database Config - Configuración

Infraestructura

• CI/CD Guide - Pipeline de integración continua
• Backup Strategy - Estrategia de backups
• Multi Tenancy - Arquitectura multi-tenant
• Sentry Setup - Monitoreo de errores
• Branding - Guía de marca

📊 Sprints

Los documentos de sprints completados están en sprints/:

Sprint	Estado	Documento
Sprint 1	✅	Policies & RBAC
Sprint 2	✅	Controllers & Bugs
Sprint 3	✅	Cache & Performance
Sprint 4	✅	Redis Cache
Sprint 5	✅	RBAC Tests
Sprint 6	✅	Cache Optimization
Sprint 7	✅	Controllers/Policies
Sprint 8	✅	Módulo IA + PHPStan
Sprint 9	✅	PHPUnit Attributes
FASE 10	✅	Service Layer + CQRS
FASE 11	✅	Test fixes + Production bugs

📦 Archivos Históricos

La carpeta archive/ contiene documentación histórica que ya no es activa pero se preserva para referencia:

• Documentos de fases completadas (FASE 1-11)
• Resúmenes de sesiones de trabajo
• Auditorías y análisis anteriores
• Planes de implementación completados
• Backups de archivos refactorizados