Cómo colocar el resumen de una página

En este artículo te mostraremos cómo configurar el resumen SEO (también conocido como la descripción o simplemente como el resumen) de un artículo en el sitio de MDN Web Docs. El resumen se usa de varias maneras:

  • Lo utilizan Google y otros motores de búsqueda para ayudar a catalogar e indexar páginas.
  • Los motores de búsqueda muestran el resumen en las páginas de resultados de búsqueda para ayudar a los lectores a elegir la página que mejor se adapte a sus necesidades.
  • Los menús de MDN a menudo muestran el resumen debajo del título del artículo para ayudar a los usuarios a encontrar la información que buscan.
  • Los enlaces en MDN tienen información sobre las herramientas del resumen, para proporcionar una visión rápida a los usuarios sin tener que hacer clic en el artículo en sí.

Por lo tanto, el resumen debe ser un texto que tenga sentido tanto en el contexto del artículo como cuando se presenta solo en otros contextos. Se debe tener en cuenta la guía de estilo de escritura MDN al escribir el texto de resumen.

El resumen predeterminado

Las páginas para las que no se ha establecido un resumen toman como resumen el texto completo del primer bloque de HTML que parezca tener contenido de texto en lugar de un título. Sin embargo, este texto puede no se el mejor para usar por varias razones:

  • Si el primer bloque de texto es una nota recordatoria en lugar de una descripción general útil del contenido del artículo.
  • Si el primer bloque de texto es un párrafo de contenido pero no contiene una buena descripción general del artículo.
  • El texto es demasiado largo (o demasiado corto).

Por esto es mejor establecer explícitamente el resumen de la página, para ayudar a garantizar que el resumen sea lo más útil posible.

Estableciendo el resumen

Veamos cómo configurar el resumen de una página.

¿Cuál es la tarea?

Marcar el texto dentro de una página que debe usarse como resumen en otros contextos; Si el texto apropiado no está disponible, esta tarea puede incluir escribir una pequeña cantidad de texto apropiado.

¿Dónde necesita ser hecho?

En las páginas que carecen de un resumen, las que tengan un resumen que no sea útil, o que tengan un resumen que no cumpla innecesariamente con las pautas recomendadas.

¿Qué necesitas saber para hacer la tarea?

Necesitas saber usar el editor MDN. También necesitas buenas habilidades de escritura y familiaridad con el tema de la página a resumir.

¿Cuáles son los pasos para hacerlo?

  1. Elige una página a la que quieras colocarle un resumen:
    1. En la página de estado de la documentación MDN, haz clic en el enlace debajo de  Secciones (Sections) para un tema en el que tengas conocimientos (por ejemplo, HTML).
    2. En la página de estado de la documentación del tema, haz clic en la cabecera Páginas (Pages) de la tabla Resumen (Summary). Esto te va a llevar a un índice de todas las páginas en esa sección del tema. Muestra los enlaces de la página en la columna izquierda y las etiquetas y resúmenes en la columna derecha.
    3. Elige una página en la que falte el resumen o que tenga uno pobre.
    4. Haz clic en el enlace para ir a esa página.
  2. Haz clic en Editar (Edit) para abrir la página en el editor MDN.
  3. Busca una oración o dos que anden como resumen fuera del contexto. Si fuera necesario, edita el contenido existente para crear o modificar las oraciones y así obtener un buen resumen.
  4. Selecciona el texto a usar como resumen.
  5. En el widget Estilos (Styles) de la barra de herramientas del editor selecciona Resumen SEO (SEO Summary). (En el código fuente de la página, esto crea un elemento  <span> con class="seoSummary" encerrando el texto seleccionado).
  6. Guarda tus cambios con un comentario de revisión como "Coloqué el resumen a la página".

Elaboración de un buen resumen

El resumen se utiliza en diversos escenarios entre los que se pueden incluir:

  • La descripción del artículo en las páginas de resultados de búsqueda en MDN así como en Google y otros motores de búsqueda.
  • La descripción del artículo en los menús y páginas de aterrizaje de temas en MDN.
  • Las descripciones emergentes contextuales cuando el usuario pasa el cursor sobre los enlaces a los artículos en MDN.

Es importante tener presentes estos escenarios mientras se crea un resumen. Para garantizar que el resumen funcione bien en todas estas situaciones, esfuérzate por ceñirte a las pautas que se indican a continuación.

Nota: a menos que se indique específicamente lo contrario, estas son orientaciones, no reglas rígidas y rápidas. Aunque debes esforzarte por cumplir estas directrices, en ocasiones se presentan excepciones que no se pueden evitar.

  •  El resumen debe indicar tanto el tema como el tipo de página. Por ejemplo «En esta guía, aprenderemos a utilizar la API del Observador de Intersección para crear aplicaciones web adaptables que actualizan únicamente las animaciones actualmente visibles en pantalla» es de 189 caracteres y explica qué tecnología se está cubriendo, cómo se está utilizando y que el artículo es un tutorial.
  • Se puede elegir el texto de cualquier lugar de cualquier párrafo del artículo, pero lo ideal sería que estuviera en el primer párrafo (o en el segundo, en algunos casos). Si el propósito del artículo no aparece en estos párrafos, es probable que necesite reescribirse la introducción de la página.
  • El resumen debe ajustarse bien al contexto del cuerpo del artículo, ya que de hecho forma parte del artículo.
  • Está bien tener enlaces a otras páginas dentro del resumen. Estos se eliminan automáticamente antes de entregarlos a los motores de búsqueda y no te afectan. También se eliminan antes de que el resumen se utilice como descripción emergente. Los enlaces no se eliminan del resumen cuando se emplean como descripción de la página dentro de los menús y páginas de destino en MDN, lo cual también es muy conveniente.
  • El resumen debe incluir una selección apropiada de los términos clave que probablemente busque alguien que averigüe por información contenida en la página. En el caso del ejemplo de la API del Observador de Intersecciones, esas palabras clave incluyen el nombre de la API, «animaciones», «visible», «adaptable» y «aplicaciones web», entre otras.
  • Para optimizar el valor del posicionamiento en buscadores (Search Engine Optimization, SEO) obtenido de un resumen, este no debe tener más de 150 caracteres de longitud.
  • Puesto que una página de resultados de un motor de búsqueda (Search Engine Result Page, SERP) no suele mostrar más de 160 caracteres del resumen, se deben evitar resúmenes de mayor longitud. El hecho de que se corte el texto sin escrúpulos puede disuadir a las personas a pulsar en el enlace.
  • Puede resultar tentador escribir un gran resumen que no funcione en la página y luego ocultarlo dentro de un bloque con la clase «hidden» en él. Pero esto no funciona, dado que los motores de búsqueda ignoran el texto que no es visible para el usuario.

Piensa en el resumen como si fuera una especie de blurb en el interior de la cubierta o la contracubierta de un libro. Este texto corto tiene que captar la atención del lector rápidamente y animarle a seguir leyendo.

Puede ser un poco complicado redactar un resumen que funcione bien tanto para las páginas de resultados de los motores de búsqueda como dentro del propio texto del artículo, pero en el momento MDN no ofrece una forma de crear un resumen SEO separado del contenido de la página, de modo que haz tu mejor esfuerzo.

Ver también