Manglende alternativ tekst er let at overse i Markdown, fordi kilden stadig kan se komplet ud. Billedsyntaksen er til stede, filstien er til stede, og dokumentet kan gengives med skærmbilledet synligt. Den manglende del er teksten inden for parenteserne.
Tekniske forfattere bør fange det, før de udgiver. Convertys Markdown Validator kan vise manglende alt-tekst sammen med andre forfatteradvarsler, så problemet er synligt, mens kilden stadig er nem at rette.
Hvorfor manglende alternativ tekst gemmer sig i Markdown
Markdown billedsyntaks ser sådan ud:
Når beskrivelsen mangler, kan billedet stadig gengives:
Det gør det nemt at gå glip af problemet under en visuel scanning. Siden ser måske fint ud for forfatteren, men kilden har mistet brugbar kontekst for læsere, der er afhængige af tekstalternativer, og for anmeldere, der forsøger at forstå billedets rolle.
Tjek billeder under forhåndsvisningen
Et praktisk dokument-workflow bør omfatte ét billedfokuseret gennemgangstrin:
- Indsæt Markdown i Markdown Validator.
- Gennemgå den gengivede forhåndsvisning for at bekræfte, at billedet vises.
- Læs advarselslisten for manglende alt-tekst.
- Vend tilbage til kilden og skriv en kortfattet beskrivelse, der forklarer billedets formål.
- Tjek dokumentet igen før publicering eller forpligtelse.
Dette er hurtigere end at vente på, at en korrekturlæser fanger problemet i en pull-anmodning eller offentliggjort side.
God alt-tekst afhænger af kontekst
Alt tekst skal beskrive, hvorfor billedet er vigtigt i dokumentet. Et skærmbillede af en CSV-validator behøver ikke hver synlig pixel beskrevet. Det kan være nødvendigt at sige, at validatoren viser duplikerede header-advarsler eller en parset forhåndsvisning af importerede rækker.
Den bedste beskrivelse afhænger af den omgivende tekst. Hvis afsnittet allerede forklarer billedet fuldt ud, kan alt-teksten være kort. Hvis billedet indeholder ny information, bør alt-teksten hjælpe med at bevare denne information.
Par alt-tjek med bredere Markdown QA
Manglende alternativ tekst er et forfatterproblem blandt flere. Et godt forhåndsvisningspas bør også kontrollere overskriftsstruktur, links, tabeller og kodehegn.
For den bredere arbejdsgang, læs Sådan fanger du Markdown-problemer før udgivelse. Til teamgennemgang skal du bruge How Product and Docs Teams Can Review Markdown Without Losing Formatting.
Åbn Markdown Validator, før du udgiver Markdown, når skærmbilleder eller diagrammer er en del af dokumentet.
