Files
frontend/docs/manual-outline.md

4.3 KiB

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