Manual Técnico
Documentación de arquitectura, implementación y mantenimiento de Gestión Civis, dirigida al equipo de desarrollo.
El manual se organiza en dos bloques: el núcleo transversal (común a toda la aplicación) y la documentación módulo a módulo (que sigue una plantilla homogénea).
Núcleo transversal
| Apartado | Contenido |
|---|---|
| Stack tecnológico | Versiones de backend y frontend, librerías clave. |
| Arquitectura general | App factory, blueprints, estructura de carpetas, ciclo de petición. |
| Autenticación y autorización | JWT, @token_required, RBAC, roles funcionales. |
| Sistema de errores | AppException, catálogos de errores, formato de respuesta. |
| MOS | Auditoría (emit_event), reglas, acciones y tareas programadas. |
| Almacenamiento de ficheros | Abstracción local / GCS. |
| Convenciones de la API | Formato de respuestas, paginación, prefijos. |
| Modelo de datos | Entidades principales y relaciones. |
Módulos
La documentación técnica de cada módulo sigue la plantilla establecida en el módulo Registro:
- Propósito y alcance
- Estructura de archivos
- Modelos de datos (tablas, campos, relaciones, enums)
- Endpoints REST (método, ruta, permiso, propósito)
- Servicios internos (responsabilidad y funciones clave)
- Permisos y roles
- Integraciones (MOS, otros módulos, sistemas externos)
Cómo leer las referencias al código
Cuando aparece una referencia como app/modules/registro/routes.py:384, indica
el archivo y la línea aproximada en el repositorio Gestion_Civis. Las líneas
pueden desplazarse con el tiempo; úsalas como punto de partida, no como
referencia exacta permanente.