Se agregaron cambios en vucem y settings

This commit is contained in:
2025-08-06 10:37:03 -06:00
parent f48f0ae6d4
commit 0178f5659a
5 changed files with 501 additions and 18 deletions

135
docs/documentation-guide.md Normal file
View File

@@ -0,0 +1,135 @@
# Guía para Documentar la Aplicación EFC
## Metodología Recomendada
### 1. CAPTURA DE PANTALLAS SISTEMÁTICA
#### Preparación:
- Usar datos de prueba consistentes
- Configurar resoluciones estándar (1920x1080, 1366x768)
- Usar navegadores principales (Chrome, Firefox, Safari)
- Preparar diferentes roles de usuario
#### Herramientas recomendadas:
- **Snagit** - Para capturas profesionales con anotaciones
- **Loom** - Para videos explicativos
- **Figma** - Para crear diagramas de flujo
- **Draw.io** - Para diagramas técnicos
### 2. ESTRUCTURA DE CADA SECCIÓN
Para cada funcionalidad documentar:
1. **Objetivo** - ¿Para qué sirve?
2. **Prerrequisitos** - ¿Qué se necesita antes?
3. **Paso a paso** - Procedimiento detallado
4. **Screenshots** - Pantallas relevantes
5. **Consejos** - Mejores prácticas
6. **Troubleshooting** - Problemas comunes
### 3. PLAN DE DOCUMENTACIÓN
#### Semana 1: Funcionalidades Básicas
- [ ] Acceso al sistema
- [ ] Navegación general
- [ ] Panel principal
#### Semana 2: Gestión de Contenido
- [ ] Expedientes
- [ ] Documentos
- [ ] Búsquedas y filtros
#### Semana 3: Funcionalidades Avanzadas
- [ ] Procesos
- [ ] Administración
- [ ] Reportes
#### Semana 4: Integración y Finalización
- [ ] VUCEM
- [ ] Notificaciones
- [ ] Revisión y ajustes
### 4. CONSIDERACIONES TÉCNICAS
#### Responsive Design:
- Documentar vista desktop
- Documentar vista móvil/tablet
- Mostrar cómo cambia la interfaz
#### Roles de Usuario:
- Importador
- Administrador
- Grupos específicos (3,5)
#### Estados del Sistema:
- Con datos
- Sin datos
- Estados de carga
- Estados de error
### 5. FORMATO DE DOCUMENTACIÓN
#### Para cada pantalla incluir:
```markdown
## [Nombre de la Funcionalidad]
### Descripción
Breve explicación de qué hace esta funcionalidad.
### Acceso
Cómo llegar a esta pantalla.
### Elementos de la Interfaz
1. **Header/Encabezado**: [descripción]
2. **Barra lateral**: [descripción]
3. **Área principal**: [descripción]
4. **Controles**: [descripción]
### Procedimientos
#### Para [acción específica]:
1. [Paso 1 con screenshot]
2. [Paso 2 con screenshot]
3. [Resultado esperado]
### Consejos y Buenas Prácticas
- [Consejo 1]
- [Consejo 2]
### Problemas Comunes
- **Problema**: [descripción]
**Solución**: [pasos para resolver]
```
### 6. CONTROL DE CALIDAD
#### Checklist por sección:
- [ ] Screenshots actualizados
- [ ] Pasos verificados
- [ ] Texto claro y conciso
- [ ] Formato consistente
- [ ] Links funcionando
- [ ] Información de roles correcta
### 7. HERRAMIENTAS DE COLABORACIÓN
#### Para equipos:
- **Slack/Teams** - Comunicación
- **Trello/Jira** - Seguimiento de tareas
- **Google Drive/SharePoint** - Almacenamiento colaborativo
- **GitHub** - Versionado si usas Markdown
### 8. MANTENIMIENTO
#### Plan de actualización:
- Revisar cada release
- Actualizar screenshots con cambios de UI
- Verificar procedimientos
- Actualizar enlaces y referencias
## Próximos Pasos
1. **Configurar entorno de documentación**
2. **Definir estilo y formato**
3. **Crear plantillas**
4. **Comenzar con funcionalidades básicas**
5. **Establecer proceso de revisión**

183
docs/manual-outline.md Normal file
View File

@@ -0,0 +1,183 @@
# Manual de Usuario - Sistema EFC
## Guía Completa para la Gestión de Expedientes y Documentos Aduaneros
---
### 📋 TABLA DE CONTENIDOS
## PARTE I: PRIMEROS PASOS
### 1. Bienvenida al Sistema EFC
- ¿Qué es EFC?
- Beneficios del sistema
- Requisitos mínimos del sistema
### 2. Acceso y Autenticación
- Registro en el sistema
- Inicio de sesión
- Recuperación de contraseña
- Gestión de sesiones
## PARTE II: INTERFAZ Y NAVEGACIÓN
### 3. Conociendo la Interfaz
- Panel principal (Dashboard)
- Barra de navegación lateral
- Sistema de notificaciones
- Interfaz responsiva (móvil/tablet)
### 4. Roles y Permisos
- Usuario Importador
- Administrador de Organización
- Grupos especiales
- Permisos por funcionalidad
## PARTE III: GESTIÓN DE EXPEDIENTES
### 5. Expedientes
- ¿Qué es un expediente?
- Crear nuevo expediente
- Buscar y filtrar expedientes
- Estados de expedientes
- Acciones disponibles
### 6. Detalles de Pedimento
- Visualizar información del pedimento
- Datos asociados
- Documentos vinculados
- Historial de cambios
## PARTE IV: GESTIÓN DOCUMENTAL
### 7. Documentos
- Tipos de documentos soportados
- Subir documentos individuales
- Carga masiva de documentos
- Organización por categorías
- Búsqueda avanzada de documentos
### 8. Descargas y Exportación
- Descarga individual
- Descarga masiva
- Formatos de exportación
- Limitaciones y consideraciones
## PARTE V: PROCESOS AUTOMATIZADOS
### 9. Gestión de Procesos
- Tipos de procesos disponibles
- Configurar procesamiento automático
- Monitorear estado de ejecución
- Historial de procesos
- Manejo de errores
## PARTE VI: ADMINISTRACIÓN
### 10. Gestión de Usuarios
- Crear usuarios
- Asignar roles y permisos
- Gestión de grupos
- Desactivar usuarios
### 11. Configuración de Organización
- Datos de la empresa
- Configuraciones del sistema
- Preferencias de usuario
- Integraciones externas
## PARTE VII: REPORTES Y ANALÍTICA
### 12. Reportes
- Reportes predefinidos
- Filtros y parámetros
- Exportación de reportes
- Programación de reportes
### 13. Tableros de Control
- Tablero de almacenamiento
- Métricas de uso
- Estadísticas de documentos
- Indicadores de rendimiento
## PARTE VIII: INTEGRACIONES
### 14. Ventanilla Única (VUCEM)
- Configuración de conexión
- Sincronización de datos
- Procedimientos específicos
- Resolución de conflictos
### 15. Notificaciones
- Tipos de notificaciones
- Configuración de alertas
- Notificaciones en tiempo real
- Historial de notificaciones
## PARTE IX: SOLUCIÓN DE PROBLEMAS
### 16. Problemas Comunes y Soluciones
- Errores de conexión
- Problemas de carga de documentos
- Errores de sincronización
- Problemas de rendimiento
### 17. Preguntas Frecuentes (FAQ)
- Preguntas sobre expedientes
- Preguntas sobre documentos
- Preguntas sobre procesos
- Preguntas sobre administración
## ANEXOS
### A. Formatos de Archivo Soportados
### B. Límites del Sistema
### C. Glosario de Términos Aduaneros
### D. Referencias Legales
### E. Contacto y Soporte Técnico
---
## 🎯 PRÓXIMOS PASOS PARA CREAR EL MANUAL
### Fase 1: Configuración (1 semana)
1. **Elegir plataforma de documentación**
- GitBook (recomendado)
- Notion
- Confluence
- MkDocs
2. **Configurar entorno**
- Crear estructura de carpetas
- Definir plantillas
- Configurar herramientas de captura
### Fase 2: Contenido Base (2-3 semanas)
1. **Documentar funcionalidades principales**
- Login y navegación
- Expedientes y documentos
- Procesos básicos
2. **Capturar screenshots sistemáticamente**
- Diferentes roles de usuario
- Estados con/sin datos
- Vista desktop y móvil
### Fase 3: Contenido Avanzado (2 semanas)
1. **Administración y configuración**
2. **Integraciones y reportes**
3. **Troubleshooting**
### Fase 4: Revisión y Publicación (1 semana)
1. **Control de calidad**
2. **Pruebas con usuarios**
3. **Ajustes finales**
4. **Publicación**
## 💡 RECOMENDACIONES ESPECÍFICAS
### Para Screenshots:
- Usar datos de ejemplo consistentes
- Resolución estándar: 1920x1080
- Herramientas: Snagit o CloudApp
- Anotar elementos importantes
### Para Videos (opcional):
- Loom para procesos complejos
- Máximo 3-5 minutos por video
- Audio claro y pausado
### Para Mantenimiento:
- Revisar con cada release
- Versionado del manual
- Feedback de usuarios
- Métricas de uso del manual

79
docs/manual-structure.md Normal file
View File

@@ -0,0 +1,79 @@
# Estructura del Manual de Usuario - Sistema EFC
## 1. INTRODUCCIÓN Y CONCEPTOS BÁSICOS
- ¿Qué es EFC?
- Objetivos del sistema
- Glosario de términos aduaneros
- Roles de usuario (Importador, Administrador, etc.)
## 2. ACCESO AL SISTEMA
- Requisitos del sistema
- Proceso de registro
- Inicio de sesión
- Recuperación de contraseña
- Gestión de sesiones
## 3. PANEL PRINCIPAL (DASHBOARD)
- Navegación general
- Sidebar responsivo
- Notificaciones
- Vista general de métricas
## 4. GESTIÓN DE EXPEDIENTES
- Crear nuevo expediente
- Buscar y filtrar expedientes
- Visualizar detalles de expediente
- Estados de expedientes
- Acciones disponibles
## 5. GESTIÓN DE DOCUMENTOS
- Tipos de documentos soportados
- Subir documentos
- Descargar documentos (individual y masiva)
- Organización por pedimento
- Filtros y búsqueda avanzada
## 6. PROCESOS AUTOMATIZADOS
- Tipos de procesos disponibles
- Configurar procesamiento
- Monitorear estado de procesos
- Historial de ejecuciones
## 7. ADMINISTRACIÓN DE USUARIOS
- Crear usuarios
- Asignar roles y permisos
- Gestionar grupos de usuarios
- Configuración de accesos
## 8. CONFIGURACIÓN DE ORGANIZACIÓN
- Datos de la organización
- Configuraciones específicas
- Preferencias del sistema
## 9. REPORTES Y TABLEROS
- Reportes disponibles
- Tablero de almacenamiento
- Métricas y estadísticas
- Exportación de datos
## 10. INTEGRACIÓN CON VUCEM
- Conexión con Ventanilla Única
- Sincronización de datos
- Procedimientos específicos
## 11. NOTIFICACIONES
- Tipos de notificaciones
- Configuración de alertas
- Historial de notificaciones
## 12. SOLUCIÓN DE PROBLEMAS
- Problemas comunes
- Códigos de error
- Contacto con soporte
- FAQ
## 13. ANEXOS Y REFERENCIAS
- Formatos de archivo soportados
- Límites del sistema
- Actualizaciones y changelog
- Referencias legales