Tipos de Recursos

Recursos de Uso General

FICHA

Recurso de uso genérico, que permite proporcionar una tarjeta de presentación de un tema o materia. Por concepto, una ficha no debería ser muy extensa, sino permitir tener una visión rápida de un concepto, así como proponer enlaces (tanto externos como enlaces a otros recursos) para el que quiera seguir profundizando.

MANUAL

A diferencia de la ficha, un manual presenta un tema pero de manera amplia, tratando de dar una visión global que toque o pase por todos los aspectos relacionados con dicha temática. Suele tener un enfoque amplio en cuanto a alcance pero sin poder profundizar demasiado, debido a lo ambicioso de su enfoque.

También se puede utilizar el tipo de recurso manual para especificar un conjunto de instrucciones o pasos que hay que ejecutar para obtener un resultado.

En ningún caso debe entenderse la finalidad del tipo de recurso manual la de almacenar un manual de una aplicación.

REFERENCIA

Con un enfoque o alcance mucho más limitado que el manual, pero que describe con alto nivel de detalle determinado/s aspecto/s que se consideran de especial interés sobre una materia.

EJEMPLO

Recurso para definir algún ejemplo o ejemplos que se circunscriban a una misma temática.

ESPECIFICACIÓN

Recurso para incluir o mencionar una especificación, norma o estándar, que se relacione con una pauta o procedimiento.

No cometer el error de repetir la norma como contenido web MADEJA, sino que se debe proporcionar una pequeña introducción, acompañada en el apartado "Características" opcionalmente por un párrafo con más detalle si se quiere destacar algo en concreto del detalle de la norma o bien si se quiere realizar un resumen general de características (vista de pájaro). Por último, incluir el enlace a la web del organismo o institución oficial que mantiene la especificación.

LEGISLACIÓN

Recurso para incluir o referenciar un texto legislativo que se relacione con una pauta o procedimiento.

No cometer el error de repetir la ley como contenido web MADEJA, sino que se debe proporcionar una pequeña introducción, acompañada en el apartado "Características" opcionalmente por un párrafo con más detalle si se quiere destacar algo en concreto del detalle de la ley o bien si se quiere realizar un resumen general de características (vista de pájaro). Por último, es importante incluir el enlace a una fuente confiable que mantenga el texto íntegro oficial de la ley, incluyendo versiones consolidadas (BOE, BOJA, DOUE). Es preferible esto último, aunque también como opción se puede adjuntar al recurso directamente el propio documento normativo.

PLANTILLA

Recurso reservado para albergar cualquier tipo de archivo que constituya una plantilla de trabajo. En la mayoría de los casos serán plantillas en formato documento asociadas con entregables que se generan durante el ciclo de vida del desarrollo de SW. Por propia definición, debe incluir un enlace que te lleve a la descarga de la plantilla.

HERRAMIENTA

Recurso destinado a la descripción de cualquier tipo de herramienta, ya sea proveniente de una comunidad de SW libre como comercial o desarrollada a medida para la Junta de Andalucía. Por lo general se trata de sistemas de información orientados a proporcionar una utilidad, generalmente de naturaleza técnica (no son sistemas de información con una finalidad de negocio).

SERVICIO

El tipo de recurso "Servicio" se ha utilizado principalmente en el Subsistema de Verificación. Debe ser entendido en el contexto de la "prestación de un servicio" (el ejemplo más típico son los servicios de ejecución de testing). No debe entenderse este recurso a nivel técnico, para representar servicios web a nivel de aplicación.

PÁGINA

Este tipo de recurso se utiliza para poder dar cabida a determinados recursos puntuales que por su naturaleza no se ajustan ni se prestan a ser definidos como un tipo de recurso cerrado del modelo de información. Por tanto un recurso de tipo página se caracteriza básicamente por un título y una descripción donde los apartados se pueden desarrollar más libremente. El uso del tipo de recurso página está restringido (se debe pedir autorización), ya que en general se debe estudiar la forma de homogeneizar los recursos mediante la definición de un catálogo común de tipos.

TÉCNICA

El tipo de recurso 'Técnica' se utiliza en general para realizar definiciones de técnicas o conceptos de carácter metodológico dentro del ámbito de MADEJA. Es un recurso de uso minoritario.

EXPERIENCIA

El tipo de recurso 'Experiencia' se creó para describir aspectos técnicos que no están tanto basados en conceptos formales o teóricos sino en experiencias empíricas o conocimientos de tipo práctico. Este tipo sólo ha sido utilizado en el subsistema de Desarrollo y su uso es minoritario

 

Recursos de Uso Específico

FICHA TÉCNICA

Recurso típicamente ligado al Subsistema de Desarrollo, que se asocia con una tecnología para presentar sus principales características, ventajas e inconvenientes, etc.

API

Recurso temporalmente creado en Drupal para la migración de los recursos de xwiki que actualmente describen un API.

Realmente la descripción de un API que un sistema ofrece a otras aplicaciones idealmente debería incluirse en el entregable "Manual de Integración" que debe acompañar a cada entrega, y el cual se publicaría en el Catálogo de SW en el momento de la liberación de la versión. No debería haber descripción de APIs a detalle como contenidos de MADEJA, ya que son susceptibles de quedar desactualizados muy frecuentemente.

Por tanto NO se debe utilizar el recurso de tipo API para la creación de nuevos contenidos. Este recurso existirá temporalmente exclusivamente para poder ir eliminando los contenidos de MADEJA que hacen referencia a la descripción de APIs (y pasando esta información al correspondiente manual).

ARQUETIPO SOFTWARE

Recurso típicamente ligado al Subsistema de Desarrollo. Describen esqueletos de código que constituyen la base de nuevos desarrollos. Los arquetipos deben incluir la estructura base de los diseños tecnológicos que se deben aplicar en la Junta de Andalucía. Constituyen una pieza de partida importante para el desarrollo de nuevas aplicaciones.

PATRÓN

Recurso típicamente ligado al Subsistema de Desarrollo. Describe un patrón empleado para la solución de un problema surgido durante el desarrollo de una aplicación. Incluye información sobre la motivación, aplicabilidad, estructura e implementación del patrón.

ROL

El tipo de recurso 'Rol' ha sido creado para representar los distintos roles implicados en los procesos de gestión del desarrollo y mantenimiento de software, por lo que, cualquier información de este tipo debe recogerse en este tipo de elemento, el cuál permite la introducción del título y descripción del rol, además de recoger la relación de éste con procesos y actividades concretas.