Manglende alt-tekst er lett å overse i Markdown fordi kilden fortsatt kan se fullstendig ut. Bildesyntaksen er til stede, filbanen er til stede, og dokumentet kan gjengis med skjermbildet synlig. Den manglende delen er teksten innenfor parentesene.
Tekniske forfattere bør fange det før de publiserer. Convertys Markdown Validator kan vise manglende alt-tekst sammen med andre forfatteradvarsler, så problemet er synlig mens kilden fortsatt er enkel å fikse.
Hvorfor manglende alt-tekst skjuler seg i Markdown
Markdown-bildesyntaks ser slik ut:
Når beskrivelsen mangler, kan bildet fortsatt gjengi:
Det gjør problemet lett å gå glipp av under en visuell skanning. Siden kan se bra ut for forfatteren, men kilden har mistet nyttig kontekst for lesere som er avhengige av tekstalternativer og for anmeldere som prøver å forstå bildets rolle.
Sjekk bildene under forhåndsvisningspasset
En praktisk dokumentarbeidsflyt bør inkludere ett bildefokusert gjennomgangstrinn:
- Lim inn Markdown i Markdown Validator.
- Se gjennom den gjengitte forhåndsvisningen for å bekrefte at bildet vises.
- Les advarselslisten for manglende alt-tekst.
- Gå tilbake til kilden og skriv en kortfattet beskrivelse som forklarer formålet med bildet.
- Kontroller dokumentet på nytt før publisering eller forpliktelse.
Dette er raskere enn å vente på at en anmelder skal fange opp problemet i en pull-forespørsel eller publisert side.
God alt-tekst avhenger av kontekst
Alternativ tekst skal beskrive hvorfor bildet er viktig i dokumentet. Et skjermbilde av en CSV-validator trenger ikke alle synlige piksler beskrevet. Det kan være nødvendig å si at validatoren viser dupliserte overskriftsadvarsler eller en analysert forhåndsvisning av importerte rader.
Den beste beskrivelsen avhenger av teksten rundt. Hvis avsnittet allerede forklarer bildet fullt ut, kan alt-teksten være kort. Hvis bildet inneholder ny informasjon, bør alt-teksten bidra til å bevare denne informasjonen.
Par alt-sjekker med bredere Markdown QA
Manglende alternativ tekst er ett forfatterproblem blant flere. Et godt forhåndsvisningspass bør også sjekke overskriftsstruktur, lenker, tabeller og kodegjerder.
For den bredere arbeidsflyten, les How to Catch Markdown Issues Before Publishing. For teamgjennomgang, bruk How Product and Docs Teams Can Review Markdown Without Losing Formatting.
Åpne Markdown Validator før du publiserer Markdown når skjermbilder eller diagrammer er en del av dokumentet.
