Guía de Uso para el Lector

¿Qué es MADEJA?

MADEJA es el Marco de Desarrollo de la Junta de Andalucía que proporciona un conjunto de directrices a tener en cuenta en el desarrollo del software corporativo, así como dar a conocer los recursos y herramientas disponibles.

El portal de MADEJA

[[wysiwyg_imageupload:740:]]

• Cabecera: Esta parte será fija en todo el portal y nos facilita el acceso a opciones generales, las cuáles dependerán de si el usuario está identificado o no en el portal: Mapa de la web, Acceso, búsqueda de texto de forma general en los contenidos del portal, incremento / decremento del tamaño de letra, acceso al entorno corporativo (si estamos identificados), Blog y Contacto (estas dos opciones aparecen para los usuarios no identificados).
• Menú: La barra de menú nos facilita el acceso a partes concretas del portal, teniendo en cuenta el nivel que seleccionemos en el menú nos mostrará una página general del menú o la correspondiente a un apartado concreto:
• • INICIO, MADEJA, BUSQUEDAS y CONSULTAS, AYUDA y SOPORTE (Para usuarios no registrados)
  • COMUNIDAD y MI ESPACIO para usuarios registrados, dependiendo del perfil del mismo.
• Contenido: Dependiendo del contenido al que accedamos en MADEJA, la información del portal será mostrada en este apartado.
• Pie: Incluye el logo de la Junta y los identificadores del cumplimiento de las normas de accesibilidad (AA).

Menú

El menú de MADEJA se encuentra debajo de la cabecera, y siempre está disponible, independientemente del contenido que se este mostrando. Consta de una serie de botones cuyas funciones son:

• INICIO. Permite volver a la pantalla inicial del portal.
• MADEJA. Dependiendo de si se trata de un usuario conectado o no habrá una serie de opciones para acceder de forma directa a contenidos específicos del portal:
• • Definición y objetivos de MADEJA.
  • Acceso directo a cada subsistema de MADEJA.
  • Visualización del mapa de procesos de MADEJA.
• BÚSQUEDAS Y CONSULTAS. A través de esta opción, se ofrecen formas rápidas de búsqueda y acceso a información concreta: pautas, procedimientos o recursos. Adicionalmente, ofrece opciones de consulta de todos los contenidos del portal relacionados con un perfil determinado, fase del ciclo de vida o tecnología. La pantalla principal de consultas ofrece acceso rápidos a las consultas anteriores, además de ofrecer un listado de los contenidos más visitados, los más recientes y los más descargados. En esta pantalla, se muestra un cuadro con las etiquetas asociadas a los contenidos más visitados, permitiendo acceder de forma rápida a todos los elementos asociados a dicha etiqueta, por ejemplo, contenidos sobre Seguridad, el ENS, la LOPD, Drupal, etc...
• AYUDA Y SOPORTE. En esta opción se muestran las opciones en función de si el usuario está identificado o no en el portal. Para los usuarios no identificados permite el acceso a la guía del lector, del redactor y validador de contenidos de MADEJA. Además de la FAQ y el glosario de términos del portal. Si el usuario está identificado, podrá consultarse también el material de formación que se haya publicado, así como acceder a la información de acceso al soporte a usuarios a través del CAU_TIC.

Adicionalmente, los usuarios identificados en el sistema podrán ver las siguientes opciones:

• COMUNIDAD. Permite el acceso al Foro y Blog de MADEJA, así como acceder a la lista de usuarios de la comunidad.

Contenido

Los contenidos en MADEJA se clasifican en distintas secciones principales que se denominan Subsistemas. En el siguiente gráfico se muestran los subsistemas en que se divide.

[[wysiwyg_imageupload:573:]]

Cada subsistema contiene a su vez un conjunto de secciones denominadas Áreas, y éstas a su vez incluyen lo que se llaman Pautas, Procedimientos y Recursos.
A continuación se detalla cada uno de estos tipos de información.

SUBSISTEMAS

Los subsistemas son los elementos principales en los que se estructura la información de MADEJA. Los subsistemas definidos actualmente, de acuerdo al gráfico anterior, son:

• Arquitectura: En este subsistema se describe una propuesta de modelo de arquitectura tecnológica de referencia. Se describe la arquitectura de sistemas de información de la Junta de Andalucía, incluyendo recomendaciones acerca de su uso y su integración con sistemas de información, herramientas e infraestructuras horizontales. Incluye también información acerca de la integración de sistemas de información, basados en el concepto de arquitectura orientada a servicios.
• Catálogo: La información contenida en este subsistema se centra en el fomento de la reutilización del código, definiendo un modelo de licencia y promoviendo el uso del Catálogo de Software.
• Desarrollo: El objetivo de la información recogida en este subsistema es la normalización de aspectos relacionados con la codificación. En este subsistema se tratan temas como convenios de codificación, tecnologías recomendadas y permitidas, desarrollo de  aplicaciones seguras, buenas prácticas para mejorar el rendimiento de aplicaciones, etc.
• Interfaz de usuario: Se incluyen en este subsistema aspectos relacionados con la interacción con los usuarios a nivel de interfaz de las aplicaciones.
• Entorno: Es este subsistema se recoge la información relativa a aspectos relacionados con los entornos de ejecución, concretamente con la gestión de entregas y la gestión de entornos y despliegues.
• Ingeniería: La información incluida en este subsistema se centra en la metodología de ingeniería del software, incluyendo aspectos de ingeniería de requisitos, creación y evolución de sistemas, gestión de proyectos, comunicación y difusión, etc.
• Verificación:  En este subsistema se incluye información acerca de mecanismos que permitan evaluar el nivel de excelencia de los desarrollos, en cuanto a nivel de cumplimiento o conformidad con las normas de MADEJA Se incluyen criterios de verificación, sistemas de validación y herramientas automatizadas que guíen y faciliten la realización de pruebas y la verificación del código, de acuerdo a las directrices de MADEJA.

Todos los subsistemas tienen la misma estructura, con el objetivo de facilitar su lectura:

• Texto descriptivo del subsistema, donde se describen sus objetivos y se incluye un índice de contenidos
• Áreas: El elemento Área se define si en un subsistema es necesario tratar aspectos de cierta envergadura, cada uno de ellos se agrupa en un tipo de contenido denominado área. El índice de contenidos de un subsistema es por tanto enlaces directos a cada una de las áreas en las que un subsistema ha considerado dividirse.

AREAS

Un área constituye una sección concreta dentro de un subsistema que trata contenido específico sobre una materia determinada. Todas las áreas disponen de una introducción que orienta sobre el tipo de contenidos que incluye. Las áreas pueden seguir una estructura anidada, de forma que dentro de un área se muestre el conjunto de subáreas. Cada área mostrará, mediante presentación tabular, los siguientes tipos de contenidos:

• Pestaña de PAUTAS
• Pestaña de PROCEDIMIENTOS
• Pestaña de RECURSOS

[[wysiwyg_imageupload:574:]]

PAUTAS

Las pautas son el elemento más importante de MADEJA. Marcan cada uno de los aspectos que MADEJA considera relevantes en una determinada área, estableciendo los enunciados, mediante mensajes claros, concisos y verificables, en forma de directrices o consejos que se deben o recomiendan aplicar sobre las materias que se describen.

Las pautas se clasifican según su tipo en:

• Directrices. Conjunto de instrucciones o normas generales para la ejecución de alguna cosa. En MADEJA una directriz se encarga de fijar, de entre todas las posibilidades, la forma preferida de hacer algo. Las directrices tienen definido un carácter que puede tomar uno de los siguientes valores:
• • Obligatorias: Una directriz obligatoria es aplicable, cuando tenga sentido, sobre cualquier desarrollo realizado para la Junta de Andalucía.
  • Recomendadas: Cuando una directriz es opcional, la decisión de si aplica o no corresponderá a los responsables del desarrollo.
  • No Recomendadas: Cuando una directriz es opcional, pero se hace especial hincapié en no utilizarla. En todo caso la decisión de utilizar o no la directriz corresponderá siempre a los responsables del desarrollo.
• Consejos. Recomendaciones sobre una materia cuyo fin es facilitar la toma de decisiones. Por definición, un consejo nunca puede tener carácter obligatorio, por lo que no será necesario clasificarlo como tal en este sentido.

Consideraciones: Una directriz recomendada puede acabar convirtiéndose en obligatoria si se considera así se favorece la consecución de los objetivos generales de MADEJA. Un consejo se diferencia de una directriz en que, mientras los consejos dan pistas que faciliten al responsable de la toma de decisiones elegir la opción que más le interesa, la directriz ya selecciona la opción, de entre las posibles.

Libro de pautas: Existen ocasiones en las que algunas pautas dentro de un área se utilizan para agrupar internamente a su vez un conjunto de pautas más simples, debido a su estrecha interrelación, o bien a consideraciones que haya que hacer para aplicarlas, como la necesidad de distinguir distintos matices, escenarios de aplicación, etc. Esta agrupación que permite estructurar mejor las pautas y dotarlas de un contexto completo es lo que se conoce como “libro de pautas”. En esos casos las pautas se redactan internamente con la misma estructura, pero creando apartados para cada una de las subpautas y una tabla resumen que explique qué se debe aplicar en cada caso.

PROCEDIMIENTOS

Un procedimiento es la formalización y documentación de un proceso sistemático que, mediante la ejecución de una secuencia de actividades o fases claramente definidas y repetibles, persigue la obtención de un resultado.

Los procedimientos de MADEJA no se deben entender como secuencia de fases a nivel puramente técnico, sino que se trata de flujos de trabajo a nivel organizativo, con participación de usuarios con determinados roles dentro de la organización.

La definición de un procedimiento se caracteriza fundamentalmente por:

• Un gráfico o diagrama de flujo de actividades. Representación visual del procedimiento en forma de orden de ejecución y relaciones de dependencia entre actividades y puntos de decisión, haciendo referencia a los roles que deben ejecutar cada uno.
• Descripción detallada de cada una de las actividades que componen el procedimiento (Descripción de la actividad, tareas a realizar, responsable y productos)

Cada uno de los procedimientos tiene definido un carácter, que puede tomar uno de los siguientes valores:

• obligatorio
• recomendado
• no recomendado
• permitido

RECURSOS

Un recurso es un elemento de MADEJA que proporciona información a un nivel de abstracción bajo, necesario o recomendable para profundizar en la aplicación de las pautas y procedimientos. Es decir, los recursos se deben considerar como contenidos de soporte o ayuda para la aplicación o alineamiento con las pautas y procedimientos.

Relación y agrupación

Los recursos aparecen agrupados en una tabla de recursos dependiente de un área específica. Aunque un recurso tiene entidad por sí mismo, normalmente los recursos toman su sentido y función dentro de MADEJA cuando van relacionados con las pautas y procedimientos. Por tanto, una pauta o procedimiento debe definir, de entre todos los recursos definidos dentro de un área, cuáles son aquellos con los que tiene relación directa, guiando de esta forma la lectura o navegación a través de los recursos. No obstante lo anterior, en la tabla de recursos de un área aparecerán listados todos los recursos relativos a dicha área, independientemente de la relación entre contenidos y su dependencia. De esta manera se muestra también una visión conjunta del contenido de MADEJA en lo relativo a un tema, y no obliga al usuario a tener que navegar por las páginas de contenido para descubrir nuevas piezas de información.

Clasificación

Los recursos se clasifican en los siguientes tipos:

1. Recursos de Uso General
1. FICHA
2. MANUAL
3. REFERENCIA
4. EJEMPLO
5. ESPECIFICACIÓN
6. LEGISLACIÓN
7. PLANTILLA
8. HERRAMIENTA
9. SERVICIO
10. PÁGINA
11. TÉCNICA
12. EXPERIENCIA
2. Recursos de Uso Específico
1. FICHA TÉCNICA
2. API
3. ARQUETIPO SOFTWARE
4. PATRÓN
5. ROL

Para saber más sobre la finalidad y uso de los tipos de recursos, ir a la guía del redactor, apartado "Tipos de recursos".

Los recursos no tienen carácter, siendo la pauta con la que se relacionan la que lo indique, en caso necesario.

Búsquedas y Consultas

El uso principal del portal MADEJA consiste en la consulta de sus contenidos, por lo que, en este apartado, indicaremos los mecanismos principales que están disponibles para la navegación a través de sus contenidos:

Navegación por subsistemas

Esta opción es la más utilizada cuando el usuario conoce el portal y sabe exactamente dónde se ubica la información que necesita.

Seleccionando la opción del menú MADEJA, indicamos el subsistema deseado. De esta forma, accedemos al contenido del mismo y, a través del enlace a sus contenidos (áreas, pautas, procedimientos y/o recursos), el usuario visualiza el detalle de los elementos de forma directa.

Desde la página inicial de MADEJA se facilitan accesos directos a los subsistemas, sin necesidad de acceder por el menú:

[[wysiwyg_imageupload:741:]]O seleccionando la opción principal “MADEJA” en el menú, en vez de un subsistema concreto:

[[wysiwyg_imageupload:742:]]

Buscador de contenidos

A través del cuadro de texto de búsqueda de la cabecera del portal. Indicaremos las palabras clave que queremos localizar. Pulsando el botón nos muestra una lista de los contenidos del portal (pautas, procedimientos, recursos, etc.) que hacen referencia a dichas palabras clave, ya sea en su título o en su contenido.

Búsquedas y Consultas

La búsqueda a través de la opción del menú principal: “Búsquedas y Consultas” cuenta con una serie de búsquedas predefinidas, ya sea mediante agrupaciones de pautas, procedimientos o recursos, o por canales temáticos de Perfiles, fases del ciclo de vida o tecnologías utilizadas.
Estos enlaces nos llevan a una lista resumen de pautas, procedimientos o recursos en la que es posible enlazar directamente a un contenido del portal o realizar una búsqueda más minuciosa, definiendo el Subsistema o Área donde se desea buscar, el tipo y carácter, en que ámbito buscar o incluso buscar por el código o titulo.

Nube de Etiquetas

Accediendo de forma directa al menú “Búsquedas y Consultas”, en vez de seleccionar una de las subopciones que ofrece, en la parte inferior derecha de la pantalla se muestra un cuadro con una serie de etiquetas que, al seleccionar una determinada, nos mostrará todos los contenidos del portal que se hayan relacionado con la etiqueta seleccionada.

[[wysiwyg_imageupload:743:]]