Saltar a contenido

Módulos (técnico)

Documentación técnica de cada módulo de negocio. Todas las páginas siguen la misma plantilla para que sean predecibles y comparables.

Plantilla de documentación de módulo

Cada página de módulo cubre, en este orden:

  1. Propósito y alcance — qué resuelve y el marco normativo, si aplica.
  2. Estructura de archivos — ficheros del módulo y su función.
  3. Modelos de datos — tablas, campos relevantes, relaciones y enums.
  4. Endpoints REST — método, ruta, permiso requerido y propósito.
  5. Servicios internos — responsabilidad y funciones clave.
  6. Permisos y roles — códigos del módulo y roles asociados.
  7. Integraciones — MOS (eventos/crons), otros módulos y sistemas externos.

Índice de módulos

Módulo Estado de la documentación
Documental ✅ Completo.
Contabilidad ✅ Completo.
Presupuesto ✅ Completo.
Registro ✅ Completo.
Tesorería ✅ Completo.
Recaudación ✅ Completo.
Padrón de Habitantes ⏳ Pendiente.
Calendario ⏳ Pendiente.

Cómo añadir un módulo

Copia registro.md como base, sustituye el contenido por el del nuevo módulo y añade la entrada correspondiente en la navegación de mkdocs.yml.