Tipo
La edición de las soluciones tecnológicas se realizará con el tipo de contenido página estándar, pero con una determinada estructura y siguiendo determinadas pautas en su redacción.
A continuación, se detallan las pautas para la edición y publicación de la solución tecnológica.
Dónde se muestra
Se muestra en la sección Soluciones tecnológicas, como parte del catálogo de soluciones, accesible dentro de Inicio > Soluciones tecnológica > Catálogo de soluciones
Cómo se busca para editarlo
Puedes localizar este contenido a través del buscador general de contenidos, donde podrás buscar por el título:
Cómo completar los campos en el gestor de contenidos
Se utilizan los campos del tipo de contenido página estándar.
Criterios editoriales
- La ficha de la solución tecnológica se estructurará en apartados, que utilizarán los títulos y orden siguientes:
- ¿Cuándo utilizarla?
- Finalidad y casos de uso
- Características y ventajas
- Detalle técnico
- Cómo adaptarla a tu caso concreto
- Preparación del entorno de desarrollo
- Adaptación
- Despliegue
- Recursos relacionados
- ¿Cuándo utilizarla?
- Los apartados mencionados en el punto anterior sirven de guía, la ficha de cada solución tecnológica se adaptará para reflejar sus características particulares, por lo que se utilizarán todos o alguno de ellos, respetando, en todo caso, el título y el orden enunciados.
- 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
Pautas generales para redactar las Soluciones tecnológicas:
- Se utilizará un lenguaje claro, conciso, adaptado a una audiencia diversa, formada por personal técnico, profesionales de TI y responsables del diseño de servicios digitales. Se ha de redactar de tal forma que personas con diferentes niveles de conocimiento técnico puedan comprender la solución y evaluar su aplicabilidad a sus necesidades.
- Se incluirán o se referenciarán ejemplos prácticos para ilustrar el uso de la solución tecnológica, facilitando su comprensión.
- Se evitará la duplicidad de información que se encuentre en otras páginas del portal, siendo preferible enlazar a dicha información mediante enlaces internos.
- Se incluirán enlaces donde se pueda acceder a recursos, activos, servicios de apoyo y otras páginas informativas, que amplíen información sobre los elementos o componentes de la solución tecnológica.
En cuanto a la redacción de los apartados propuestos se seguirán las siguientes pautas:
Apartado ¿Cuándo utilizarla?
Este primer apartado aclarará el ámbito de aplicación de la solución tecnológica, especificando en qué casos es recomendable y útil, de tal forma que sirva para orientar al lector si es pertinente su utilización para su proyecto.
La redacción adoptará un enfoque práctico y funcional, centrándose en la aplicación y posibilidades de la solución. Para ello, se seguirán las siguientes pautas:
- Evitar la jerga técnica.
- Enfocarse en la aplicación de la solución o sus posibilidades funcionales
- Excluir detalles sobre compatibilidad, tecnologías subyacentes y otros aspectos no funcionales.
- Ilustrar con casos, especificar ejemplos prácticos o que sirvan de prueba.
Podrá contener los subapartados Finalidad y casos de uso y Características y ventajas:
- Finalidad y casos de uso: Utilidad de la solución tecnológica, su propósito y ejemplos de casos de uso.
- Características y ventajas: Funcionalidades principales y beneficios que se obtienen.
Apartado Detalle técnico
En este apartado se describirá la solución tecnológica, siguiendo las siguientes pautas de edición:
- Se recomienda incluir un diagrama ilustrativo de los componentes de la solución tecnológica, acompañado de una breve descripción de cada uno de ellos.
- No se requiere un alto nivel de detalle, ya que el objetivo principal es proporcionar una visión general de la solución tecnológica, no una especificación técnica exhaustiva. Se busca que el lector comprenda la estructura básica y los principales elementos que la componen, sin profundizar en los detalles tecnológicos.
- El enfoque debe ser funcional, resaltando cómo los componentes interactúan para lograr el propósito de la solución, y no técnico, detallando las particularidades de cada componente en este sentido.
Apartado Cómo adaptarla a tu caso concreto
Este apartado contendrá una guía de adopción y adaptación de la solución tecnológica, especificando los pasos generales, para lo que se seguirán las siguientes pautas de redacción:
- Se presentarán los pasos en un orden lógico y secuencial, facilitando la comprensión y el seguimiento del proceso de adopción.
- Se evitará la duplicación de información y el exceso de detalle, priorizando la concisión y la claridad.
- Se utilizarán referencias y enlaces a páginas, recursos o documentación para ampliar la información cuando sea necesario.
- Se procurará que esos enlaces estén contextualizados y tengan sentido dentro del orden de los pasos, facilitando la navegación y la comprensión.
- Se pueden incluir recomendaciones y consejos sobre cómo personalizar la solución tecnológica para satisfacer necesidades específicas.
- Se abordarán las consideraciones prácticas para la implementación, como requisitos previos, dependencias y configuraciones necesarias.
- Cuando estén disponibles, incluir información sobre cómo obtener soporte técnico y asistencia durante el proceso de adopción.
Podrá contener los subapartados Preparación del entorno de desarrollo, Adaptación y Despliegue:
- Preparación del entorno de desarrollo: Condiciones previas o preparación del entorno.
- Adaptación: Indicaciones para la adopción y adaptación.
- Despliegue: Proceso de para que esté disponible para su uso.
Apartado Recursos relacionados
En este apartado se listarán aquellos recursos, reglas y pautas, activos, servicios de apoyo o cualquier otro recurso que pueda resultar útil para disponer de la solución tecnológica.
- Se agruparán en subapartados por cada tipo y subtipo de recurso con el título correspondiente.
- Los recursos se mostrarán en formato lista con viñetas, con enlace al nodo del recurso si está disponible.
Múltiples implementaciones
Algunas soluciones pueden tener diferentes implementaciones, en base a condiciones del proyecto, requerimientos técnicos, etc.
Cuando la extensión del apartado dedicado a la adopción y adaptación resulte excesivamente extenso, así como para facilitar la comprensión y la navegación por el contenido, se podrá separar en páginas enlazadas desde la principal de la solución. El alias de URL de dichas páginas ha de contener los niveles de la principal, añadiendo el propio.
La página principal tendrá los contenidos comunes, así como las referencias a esas cuestiones específicas.
Si es necesario, algunas cuestiones específicas se pueden indicar mediante notas o llamadas.
Puedes ver este ejemplo de una solución tecnológica con varias implementaciones.