Documentación general

Existe al menos 5 vías de documentación en el proyecto del Sistema de Reportes en Power BI MINSA, la que está leyendo en este momento llamada documentación base, documentación curso, in file, documentos de apoyo a las sesiones y la carpeta de documentación de entrega final del proyecto.

La documentación que está consumiendo en este momento fue creada inicialmente en un software llamado Notion, fue seleccionado inicialmente por su facilidad de exportación a PDF, facilidad de trabajo en línea y colaborativo.

El link se adicionó al tablero (parte superior derecha) junto con un acceso al curso de apoyo.

Los links que aparecen en la parte superior como botones pueden ser actualizados, al momento de esta documentación apuntan a la empresa consultora, pero se pueden configurar para dirigir al recurso que disponga MINSA IT.

Estos links están determinados como puente entre el sistema de reportes y sus apoyos, para cambiarlos (debe realizarse de preferencia en Power BI Desktop) se pueden buscar las medidas llamadas “Link Curso” y “Link Documentación”.

Las urls a las que se apuntan se pueden personalizar.

Documentación base

Como es de conocimiento - en cuanto a esta documentación que está leyendo - hemos dividido en 4 perfiles la documentación del proyecto, a saber:

• Documentación para el usuario que consume el reporte.
• Documentación para el usuario del área de la salud que consume el reporte
• Documentación para el área técnica (de la cuál forma parte esta página)
• Documentación para sistema de tickets y soporte (disponible hasta 30/09/2023).

Documentación del proyecto creada como paquete web.

Esta documentación será pasada a un paquete web, es decir podrá ser consumido offline u online y solo requiere el uso de un navegador.

Documentación del curso

De igual forma que para la documentación base, se usa un ícono que redirige al curso de apoyo creado inicialmente en Moodle - del cuál se entregará un paquete en la entrega final - y que estará accesible hasta el 30 de septiembre de 2023.

Documentación del curso creada como paquete web.

Posterior a esa fecha y en busca de que este curso siga disponible, se ha creado un paquete web que permita ser consultado vía offline u online.

Documentación in file

El documento de Power BI está documentado en la mayoría de estructuras y procesos, estos comentarios se realizan para guiar a los posibles usuarios finales del archivo.

Comentarios desde Power Query, con un flujo claro del origen de los datos, los pasos aplicados usando nombres descriptivos y en caso en que se requiera comentarios que ayudan al autor a realizar un mantenimiento más documentado, en la captura se determina el uso de filtros para la dimensión de calendario.

Adicionalmente en cuanto a estructura, se ha documentado cada campo que se haya considerado relevante.

Documentación en el modelo de datos a los campos.

Finalmente a nivel de campo, especialmente en cuanto a las fórmulas que requieren un poco más de detalle, se usa DAX Formatter como estándar para la generación de fórmulas de fácil lectura y el uso de comentarios que complementan la información.

Uso de estandarización DAX y ayudas de comentario para las fórmulas.

Documentación de las sesiones realizadas

Como parte del proceso se ha ido realizando entrega de cada reunión, seguimiento, capacitación que se haya realizado con los equipos internos y externos al proyecto. Se adicionará también la grabación existente para cada una.

Documentación y entrega final

Como parte del proceso de entrega, al contratante (OPS) y a la entidad (MINSA) se le hará entrega de una carpeta con toda la información relevante del proyecto, incluyendo todo lo citado anteriormente y archivos que soportaron la evaluación del mismo.

Aunque es obvio que se generarán carpetas diferentes, básicamente por temas administrativos u operativos que marcan diferencias entre el contratante y la entidad, en términos generales esta documentación será un 95% igual.

Se adicionan también archivos fuente que se considere pertinente. o que haya sido solicitado.

El despliegue de la información

En la búsqueda de lograr una mejor adaptación a la línea gráfica actual de MINSA en su sitio web, hemos creado una plantilla que mantiene congruencia con el proyecto existente, iniciamos dividiendo en 3 grandes áreas, el encabezado, el pie de página - que se mantendrán igual - y determinando el área de contenido.

Para lograr integrar mejor la documentación se creó con la misma estructura (no igual tecnología) una documentación web con el “look & feel” actual del sitio web de MINSA.

De tal manera que los contenidos del curso y los contenidos de documentación recibieran esta estructura, quedando similar a la siguiente imagen;

Usando la estructura actual se ha creado una plantilla para estas documentaciones.

Se ha creado una carpeta con el uso de preprocesadores PUG para HTML y SASS para CSS, se ha usado como base el framework Bootstrap en su versión 5.x, de esta manera aunque se ha homologado el diseño web oficial de MINSA en cuanto a encabezados y pies de página, el área central se usa para el contenido de la documentación.

La estructura a entregar estará compuesta de un “scaffolding” similar al siguiente:

Mantener referencias de hipervínculos y ligas relativas permite que se integre a cualquier sitio web existente.

De esta manera se entregará tanto el código fuente (que incluye plantillas, preprocesadores y archivos de configuración que podrán ser inicializados por un gestor tipo npm) hasta la carpeta de distribución.

La documentación no se entregará consolidada en su totalidad, básicamente son sistemas diferentes, sin embargo la documentación del curso y la documentación básica si comparten una landing que permite llamar internamente a esta estructura.

Landing page que lleva a los tres destinos: documentación, curso y reporte en línea.