Desarrollo e implementación de una aplicación para la documentación técnica y de usuario integrado al sistema IOTMACH

Abstract

El presente trabajo está basado en el desarrollo de un portal web y la utilización de herramientas Open Sources de documentación el cual tiene como finalidad gestionar la documentación que proporcione el grupo de investigación, la cual va a estar a disposición de los usuarios mediante un Portal Web, de tal forma también hacemos uso de la herramienta Doxygen para comentar y generar la documentación del código fuente de cada una de las aplicaciones que se estén desarrollando dentro del grupo IOTMACH, el portal web se considera como un componente clave para las empresas y para el suministro de información de tal forma convirtiéndose en una plataforma rápida y segura, de los cuales se han hecho estudios en donde evalúan la usabilidad de los portales web con el fin de mediar los niveles de usabilidad que tiene y la interacción con el usuario ya que es considerado como la puerta de entrada para proporcionar información y servicios de internet[1][2], en el portal lo primero que se visualiza es una página informativa en la cual se muestra al grupo IOTMACH, sus logros y demás integrantes asociados a los semilleros de investigación, sus productos de Hardware y Software que se están elaborando y productos ya elaborados, la ubicación de donde se encuentra alojado el grupo de investigación, una galería donde se visualiza nuestro entorno de trabajo y trabajo diario; cuenta con un control de ingreso que valida cuatro tipos de usuarios que son Administrador, Desarrollador, Técnico y Cliente, cada uno contiene diferentes permisos para la visualización de información disponible en nuestra página web, se puede recalcar que los usuarios nuevos pueden registrarse y automáticamente el sistema le asignará el rol de Cliente, el usuario puede cambiar de rol si tan solo si el Administrador hace la gestión del cambio de rol ya que es el único que puede acceder a dichas configuraciones, tiene incluido un Dasboard que contiene los accesos directos a cada una de las acciones que brinda el sistema, donde cada módulo tiene su propio repositorio dedicado, en el cual se aloja toda la información necesaria, como pueden ser: los manuales técnicos de desarrollador de Administrador y de usuario, códigos fuentes de las aplicaciones documentada, enlace a los repositorios (GitLab), en este repositorio están los códigos fuentes de las aplicaciones desarrolladas en su totalidad, sus versiones, entre otras acciones, también se dispone de una Wiki (Dokuwiki) utilizada en gran medida por los desarrolladores en cada una de sus etapas de trabajo, donde se brinda información de instalaciones, tutoriales, enlaces a artículos de interés común, enlaces a páginas de las cuales han tomado como referencia para realizar configuraciones, etc, por otra parte el portal fue diseñado para que sea dinámico y toda la información pueda ser editada en tiempo real de acuerdo a las necesidades del usuario que ingrese al portal, también existe la posibilidad de activar o desactivar cierta documentación de los repositorios para que esté visible desde la web, los resultados que se logra obtener es la de un repositorio en donde se pueda alojar toda la documentación de forma dinámica que se valla generando de acuerdo a como el proyecto valla evolucionando y la incorporación de nuevo módulos que se estén desarrollando de tal forma que los usuarios finales pueden realizar consultas y filtración de documentación de acuerdo a sus necesidades.