Saltar al contenido principal

Sincronización de Documentación con el Sistema (Agosto 2026)

· 3 min de lectura
Yovany Suárez Silva
Software Engineer - FullStack Developer

Esta entrega actualiza la wiki para que refleje el estado real del Módulo de Almacén, siguiendo la regla de documentación obligatoria (DOCUMENTATION.md).


🆕 Nuevos manuales de usuario​

ManualRutaContenido
Gestión de Oficinas y Áreasdocs/manuales/oficinas/gestionar-oficinas.mdCRUD oficinas, asignar responsable, conteo de usuarios
Categorías y Presentacionesdocs/manuales/productos/categorias-presentaciones.mdCatálogo de clasificación, conversión de presentaciones
Solicitudes Móvildocs/manuales/solicitudes/solicitudes-movil.mdListar, crear, editar y detalle desde el móvil
Estadísticas de Inventariodocs/manuales/inventarios/estadisticas-inventario.mdstock-by-category, rotación, estado, demanda, precisión, ciclo, heatmap
Logs de Operaciones y Auditoríadocs/manuales/auditoria/logs-operaciones.mdLogs REQUEST/AUDIT, búsqueda avanzada, interpretación
Dashboard Generaldocs/manuales/dashboard/dashboard-general.mdKPIs, comparación por período, alertas, movimientos recientes

🔄 Sincronización con el estado real del sistema​

Aplicaciones​

  • applications/ccf-almacen-api.md: puerto real 4000 (era 3000), lista de 13 módulos de dominio, RBAC con 5 roles, migraciones SQL manuales (no TypeORM), Swagger en /api.
  • applications/ccf-almacen-web.md: stack real — React Query v5 (era v4), Context API + useState (se eliminó la mención a Zustand, que no existe en el código), Pages Router para el dashboard, shadcn/ui, Jotai, exportación CSV/PDF/Excel.

Manuales existentes​

  • manuales/roles/perfiles-y-permisos.md: se agrega el rol Auxiliar inventario (ajuste de stock, movimientos, entregas por detalle) a la tabla de roles, mapa de permisos y advertencias.
  • manuales/de-usuario.md: reescrito con las 14 funcionalidades reales y un índice de manuales por módulo.
  • intro.md: corregidos enlaces rotos (propuesta y cronograma apuntaban a applications/ cuando viven en desarrollo/) y agregados los nuevos manuales.

🐞 Correcciones detectadas durante la sincronización​

  • Enlaces rotos en intro.md a manuales inexistentes (manuales/productos/crear-solicitud.md → real: manuales/solicitudes/crear-solicitud.md).
  • Documentación desactualizada del backend (puerto 3000, migraciones TypeORM inexistentes).
  • Documentación desactualizada del frontend (Zustand no está instalado; el estado real es Context API + Jotai).
  • Manual de roles no incluía el rol Auxiliar inventario presente en el enum RolUsuario del backend.

🧭 Próximos pasos sugeridos​

  • Documentar manualmente el flujo de imágenes de producto (subida, imágenes temporales, asociación) con capturas reales.
  • Agregar capturas de pantalla reales para los nuevos manuales (las imágenes referenciadas son placeholders mientras se toman capturas).
  • Documentar el módulo de notificaciones con filtro por usuario (Admin ve todas) en detalle.

Resumen: la wiki ahora refleja las 14 funcionalidades principales del sistema, el stack real de cada aplicación y los 5 roles de acceso. Para ver el estado anterior de esta tarea, consultar el informe de fase en la raíz del monorepo.