Documento activo
Indice General
Mapa general de manuales y documentos disponibles.
Indice General de la Documentacion
1. Objetivo
Este paquete documenta el sistema de gestion educativa de manera funcional y tecnica para que pueda ser entendido, operado, mantenido y ampliado por distintos perfiles:
- Direccion o administracion institucional
- Personal de soporte tecnico
- Administradores del sistema
- Docentes
- Estudiantes y padres
2. Que es este sistema
El proyecto es una plataforma web PHP orientada a la gestion educativa integral. Su alcance actual incluye:
- Autenticacion y control de acceso por roles
- Gestion academica
- Matricula
- Calificaciones y escalas de evaluacion
- Asistencia
- Aula virtual
- Biblioteca virtual
- Chat y notificaciones
- Portal publico institucional
- Mesa de partes
- Foro publico
- Reportes y documentos academicos
- Kiosko escolar con monedero y pagos
- Tareas de mantenimiento y notificaciones por cron
3. Estructura documental
Nucleo
Vision General del Sistema: descripcion ejecutiva del sistema, sus usuarios y sus modulos.Arquitectura Tecnica: estructura del proyecto, flujo de arranque, convenciones y componentes principales.Instalacion y Despliegue: requisitos, instalacion, variables, dependencias y puesta en marcha.Base de Datos y Esquema: modelo de datos, tablas relevantes y esquema dinamico.Seguridad, Permisos y Sesiones: autenticacion, roles, CSRF, sesiones, headers y controles de acceso.
Manuales funcionales
Manual Administrativo: operacion diaria desde administracion.Manual Docente: uso funcional por docentes.Manual Usuario Final: uso para estudiantes, padres y visitantes.Modulos Especiales: kiosko, mesa de partes, foro, asistencia publica y otros modulos especiales.
Operacion tecnica
Operacion Tecnica y Soporte: soporte, respaldo, logs, cron, incidentes y mantenimiento.
4. Fuentes tecnicas principales usadas para esta documentacion
- config/config.php
- config/database.php
- helpers/Auth.php
- models/Model.php
- sql/sistema_educativov2-1.sql
- views/admin/dashboard.php
- aula/index.php
- biblioteca/index.php
- mesa_partes/index.php
- publico/index.php
5. Limites de la documentacion
Esta documentacion describe el comportamiento observable en el codigo actual. Puede haber diferencias menores si:
- La base de datos productiva tiene personalizaciones no reflejadas en los scripts del proyecto.
- Se han cargado configuraciones o datos institucionales especificos.
- Existen integraciones externas activadas con claves privadas no visibles en el codigo.
6. Convencion usada
- Cuando se dice "admin" se refiere al rol con acceso mas alto dentro del sistema principal.
- Cuando se dice "areas" se refiere a roles como direccion, secretaria, tesoreria, coordinacion, bienestar y tecnologia.
- Cuando se dice "esquema dinamico" se refiere a tablas o columnas creadas automaticamente por helpers de sincronizacion.