Saltar al contenido principal

Cómo los redactores técnicos pueden encontrar el texto alternativo que falta en Markdown

Por Converty Team

Descubra cómo los redactores técnicos pueden encontrar el texto alternativo que falta en Markdown antes de que se publiquen documentos, archivos README, notas de la versión o contenido CMS.

Cómo los redactores técnicos pueden encontrar el texto alternativo que falta en Markdown

Es fácil pasar por alto el texto alternativo que falta en Markdown porque la fuente aún puede parecer completa. La sintaxis de la imagen está presente, la ruta del archivo está presente y el documento puede mostrarse con la captura de pantalla visible. La parte que falta es el texto entre corchetes.

Los redactores técnicos deberían darse cuenta de eso antes de publicar. El Markdown Validator de Converty puede mostrar texto alternativo faltante junto con otras advertencias de creación, por lo que el problema es visible mientras la fuente aún es fácil de solucionar.

¿Por qué falta el texto alternativo que se oculta en Markdown?

La sintaxis de la imagen Markdown se ve así:

![Useful description](/path/to/image.png)

Cuando falta la descripción, la imagen aún se puede representar:

![](/path/to/image.png)

Eso hace que el problema sea fácil de pasar por alto durante un escaneo visual. La página puede parecerle buena al autor, pero la fuente ha perdido un contexto útil para los lectores que dependen de alternativas de texto y para los revisores que intentan comprender el papel de la imagen.

Verifique las imágenes durante el pase de vista previa

Un flujo de trabajo de documentos práctico debe incluir un paso de revisión centrado en imágenes:

  1. Pegue el Markdown en el Validador de Markdown.
  2. Revise la vista previa renderizada para confirmar que aparece la imagen.
  3. Lea la lista de advertencias sobre texto alternativo faltante.
  4. Regrese a la fuente y escriba una descripción concisa que explique el propósito de la imagen.
  5. Vuelva a verificar el documento antes de publicarlo o confirmarlo.

Esto es más rápido que esperar a que un revisor detecte el problema en una solicitud de extracción o en una página publicada.

Un buen texto alternativo depende del contexto

El texto alternativo debe describir por qué la imagen es importante en el documento. Una captura de pantalla de un validador CSV no necesita describir todos los píxeles visibles. Es posible que sea necesario decir que el validador muestra advertencias de encabezados duplicados o una vista previa analizada de las filas importadas.

La mejor descripción depende del texto circundante. Si el párrafo ya explica completamente la imagen, el texto alternativo puede ser breve. Si la imagen contiene información nueva, el texto alternativo debería ayudar a preservar esa información.

Emparejar controles alternativos con un control de calidad de Markdown más amplio

La falta de texto alternativo es un problema de autoría entre varios. Una buena vista previa también debería comprobar la estructura de los encabezados, los enlaces, las tablas y los límites del código.

Para conocer el flujo de trabajo más amplio, lea Cómo detectar problemas de rebajas antes de publicar. Para la revisión en equipo, utilice Cómo los equipos de productos y documentos pueden revisar Markdown sin perder el formato.

Abra el Validador de Markdown antes de publicar Markdown cuando las capturas de pantalla o los diagramas formen parte del documento.

También te puede interesar