Documentación técnica de edalsoBMS¶
Plataforma de gestión de edificios inteligentes: el dato nace en los equipos instalados en el edificio, viaja a la nube, se persiste y se consume desde un portal web y una aplicación móvil.
Esta documentación cubre los seis sistemas que componen el producto y está escrita para sostener una auditoría técnica: arquitectura, contratos entre sistemas, operación, seguridad, cumplimiento y calidad.
Una fuente, dos salidas
Todo lo que hay aquí sale de los mismos ficheros markdown del repositorio
edalso-docs. Este portal es para consultar; el PDF es para entregar
—una auditoría necesita un documento con versión y fecha, no una URL que
cambia—. Los dos se generan del mismo texto, así que no pueden contradecirse.
Descargar en PDF¶
-
El documento completo, con portada, índice y numeración. Es el que se entrega en una auditoría o una sala de datos: tiene versión y fecha, y no cambia bajo los pies de quien lo revisa.
-
Inventario completo de dependencias, paquete a paquete. Va aparte porque son unas 5.000 filas y ahogarían el documento principal.
Por dónde empezar¶
-
Los seis sistemas, cómo encajan y dónde están los límites de confianza.
-
Un documento por pieza: qué hace, cómo se despliega y qué expone.
-
API REST, topics MQTT y esquemas de datos entre sistemas.
-
Autenticación, roles, gestión de secretos y superficie expuesta.
Estado de esta documentación¶
Es un documento vivo: se actualiza a la vez que el producto, en el mismo
repositorio. Lo que hay bajo Generado no se escribe a mano —lo producen los
guiones de generar/ a partir del código—, porque un inventario escrito a mano
miente a las pocas semanas y en una auditoría una tabla desfasada hace dudar de
todo lo demás.