Saltar para o conteúdo principal

Como os redatores técnicos podem encontrar texto alternativo em falta no Markdown

Por Converty Team

Saiba como os escritores técnicos podem encontrar texto alternativo em falta no Markdown antes de serem publicados documentos, ficheiros README, notas de versão ou conteúdo CMS.

Como os redatores técnicos podem encontrar texto alternativo em falta no Markdown

É fácil ignorar o texto alternativo em falta no Markdown porque a fonte pode ainda parecer completa. A sintaxe da imagem está presente, o caminho do ficheiro está presente e o documento pode ser renderizado com a captura de ecrã visível. A parte que falta é o texto entre parêntesis rectos.

Os redatores técnicos devem compreender isto antes de publicar. O Markdown Validator do Converty pode apresentar texto alternativo em falta juntamente com outros avisos de autoria, para que o problema seja visível enquanto a fonte ainda é fácil de corrigir.

Por que razão o texto alternativo em falta está oculto no Markdown

A sintaxe da imagem Markdown é semelhante a esta:

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

Quando a descrição estiver em falta, a imagem ainda poderá ser renderizada:

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

Isto torna o problema fácil de ignorar durante uma verificação visual. A página pode parecer boa para o autor, mas a fonte perdeu um contexto útil para os leitores que dependem de alternativas de texto e para os revisores que tentam compreender o papel da imagem.

Verifique as imagens durante a passagem de visualização

Um fluxo de trabalho prático de documentos deve incluir uma etapa de revisão focada em imagens:

1.º Cole o Markdown no Validador de Markdown. 2.º Reveja a visualização renderizada para confirmar se a imagem aparece. 3.º Leia a lista de avisos sobre texto alternativo em falta. 4.º Volte à fonte e escreva uma descrição concisa que explique o objetivo da imagem. 5.º Verifique novamente o documento antes de publicar ou confirmar.

Isto é mais rápido do que esperar que um revisor detete o problema num pull request ou numa página publicada.

Um bom texto alternativo depende do contexto

O texto alternativo deve descrever por que razão a imagem é importante no documento. Uma captura de ecrã de um validador CSV não necessita de todos os pixéis visíveis descritos. Pode ser necessário dizer que o validador mostra avisos de cabeçalho duplicado ou uma vista analisada das linhas importadas.

A melhor descrição depende do texto envolvente. Se o parágrafo já explica a imagem completamente, o texto alternativo pode ser breve. Se a imagem contiver novas informações, o texto alternativo deverá ajudar a preservar essas informações.

Combine verificações alternativas com Markdown QA mais amplo

A falta de texto alternativo é um problema de autoria entre vários. Uma boa passagem de visualização deve também verificar a estrutura dos títulos, ligações, tabelas e limites de código.

Para um fluxo de trabalho mais amplo, leia Como detetar problemas de redução antes de publicar. Para a revisão da equipa, utilize Como as equipas de produtos e documentos podem rever o Markdown sem perder a formatação.

Abra o Markdown Validator antes de publicar o Markdown quando as capturas de ecrã ou os diagramas fizerem parte do documento.

Também podes gostar