Skip to main content

Esta versión de GitHub Enterprise Server se discontinuó el 2024-07-09. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Combinación de varios tipos de contenido

Puede combinar varios tipos de contenido en un solo artículo para ayudar a los usuarios a completar tareas complejas.

A menudo resulta útil agrupar información en contexto para ayudar a los usuarios a realizar una tarea compleja, comprender un conjunto de tareas relacionadas o ilustrar un flujo de trabajo entero. Usa artículos más largos que combinen tipos de contenido para garantizar que los usuarios encuentren contenido contextual en el lugar oportuno. Los artículos más largos también ayudan a eliminar la duplicación de contenido y a preparar el contenido para ampliarlo a medida que se agregan más opciones al producto. Los usuarios necesitan con más frecuencia artículos más largos mientras están usando el producto, y es posible que necesiten consultar el artículo en diferentes momentos de su recorrido.

Cómo combinar varios tipos de contenido en un artículo

  • Usa contenido conceptual, de procedimientos, referencial, de solución de problemas o de problemas conocidos en un artículo más largo y no uses tutoriales ni guías de inicio rápido.
  • Usa secciones de diferentes tipos de contenido en el artículo según sea necesario y sigue las directrices para los títulos del tipo de contenido.
  • Normalmente, estos artículos contienen al menos una sección de procedimientos y una sección conceptual, referencial o de procedimientos adicional.
  • Usa las directrices de ordenación del contenido para organizar los encabezados en el artículo.
  • Usa la información de solución de problemas con la mayor frecuencia posible.
  • Puedes replicar el título del artículo en un encabezado si es necesario.

Directrices para el título de los artículos que combinan varios tipos de contenido

  • Si hay un procedimiento dentro del artículo, usa un título basado en una tarea que comience con un gerundio.
  • Los títulos son lo suficientemente generales como para describir el intervalo de información y tareas que contiene el artículo.
  • Los títulos describen la configuración que se alterna y son independientes de la configuración que elige el lector, por ejemplo, "Setting repository visibility" en lugar de "Making a private repository public".

Ejemplos de artículos que combinan varios tipos de contenido