Activo

Contenido

Tipo de contenido

Se consideran como activos todos aquellos elementos de uso general o generalizable que contribuyan a la estandarización y reutilización del desarrollo de software. Esta contribución puede ser realizada desde distintos ámbitos: ayudas al desarrollo, componentes reutilizables, herramientas, o consumo de servicios (elementos interoperables).

El tipo de contenido Activo tiene como objetivo definir o describir estos elementos.

A continuación, se detalla la estructura que deben seguir cada Activo.

Dónde se muestra

Se muestra como parte de los Recursos, accesible dentro de Inicio > Recursos > Buscador de recursos

Cómo se busca para editarlo

Puedes localizar este contenido a través del buscador general de contenidos, filtrando por el tipo Activo:

Cómo completar los campos en el gestor de contenidos

CampoDescripción
Título* 

Criterios editoriales

  • La ficha del activo se mantendrá al día con información que no suelen experimentar cambios entre versiones.
  • Contendrá los siguientes apartados:

    • Descripción
    • ¿A quién va dirigido?
    • Beneficios
    • Detalles técnicos (opc) 
    • Repositorios de código (opc)
    • Hoja de ruta (opc)
    • Necesito soporte

    (opc) Opcional dependiendo del tipo concreto de activo

  • Se utilizarán todos o alguno de los apartados anteriores, respetando, en todo caso, el título y el orden enunciados. Además, se podrán añadir aquellos que se consideren oportunos.

En cuanto a las versiones del activo:

  • Cada versión asociada al contenido de tipo Activo contendrá aquellos aspectos particulares de la versión, tales como:
    • Historial de cambios entre versiones
    • Notas de la versión
    • Dependencias propias de la versión
    • Compatibilidad
    • Problemas conocidos
    • Enlaces de descarga
    • Instrucciones específicas para la instalación de la versión
    • Requisitos de la actualización
    • Documentación específica de la versión
    • Tiempo de soporte
    • Estado de la versión si se trata de una versión de prueba, descontinuada, estable...
  • Se seguirán las pautas sobre el versionado de recursos.
  • Los apartados mencionados en los puntos anteriores sirven de guía, la ficha de cada activo se adaptará para reflejar sus características particulares.
  • Se tendrán en cuenta las recomendaciones acerca de la visibilidad de los contenidos, utilizando para ello las funcionalidad que el portal proporciona.

Pautas de redacción

Como pautas generales para la redacción del tipo de contenido Activo:

  • Se utilizará un lenguaje claro, conciso y técnico, adaptado a la audiencia de desarrolladores y profesionales de TI.
  • Se incluirán o se referenciarán ejemplos prácticos y fragmentos de código relevantes para ilustrar el uso y la implementación del activo, facilitando su comprensión.
  • Se mantendrá una estructura coherente y fácil de seguir, con una organización lógica de la información y una navegación intuitiva.
  • Si es posible, se incluirán enlaces donde se pueda acceder a artefactos del activo, como repositorios de código.
  • Cuando proceda, se referenciará o se enlazará a documentación o páginas externas, como especificaciones técnicas, APIs o estándares, para complementar la información proporcionada y ofrecer una visión completa del activo.

En estos apartados se detallan además pautas específicas de redacción de estos tipos de Activo:

  • Acelerador / plantilla
  • Aplicación / utilidad
  • Componente reutilizable
  • Dataset
  • Framework
  • Plataforma
  • Servicios / API
  • Sistema de diseño
  • Sistema de información
Índice