Nedostajući alt tekst lako je previdjeti u Markdownu jer izvor i dalje može izgledati potpun. Sintaksa slike je prisutna, putanja datoteke je prisutna, a dokument se može renderirati s vidljivim screenshotom. Nedostaje samo tekst unutar uglatih zagrada.
Technical writeri to trebaju uhvatiti prije objave. Convertyjev validator Markdowna može prikazati nedostajući alt tekst zajedno s drugim autorskim upozorenjima, tako da je problem vidljiv dok je izvor još lako popraviti.
Zašto se nedostajući alt tekst skriva u Markdownu
Markdown sintaksa slike izgleda ovako:
Kada opis nedostaje, slika se i dalje može renderirati:
Zato je problem lako propustiti tijekom vizualnog pregleda. Stranica autoru može izgledati dobro, ali izvor je izgubio koristan kontekst za čitatelje koji ovise o tekstualnim alternativama i za reviewere koji pokušavaju razumjeti ulogu slike.
Provjerite slike tijekom preview prolaza
Praktičan docs workflow treba uključiti jedan korak usmjeren na slike:
- Zalijepite Markdown u validator Markdowna.
- Pregledajte renderirani preview kako biste potvrdili da se slika prikazuje.
- Pročitajte popis upozorenja za nedostajući alt tekst.
- Vratite se u izvor i napišite sažet opis koji objašnjava svrhu slike.
- Ponovno provjerite dokument prije objave ili commita.
To je brže nego čekati da reviewer uhvati problem u pull requestu ili na objavljenoj stranici.
Dobar alt tekst ovisi o kontekstu
Alt tekst treba opisati zašto je slika važna u dokumentu. Screenshot CSV validatora ne treba opis svakog vidljivog piksela. Možda treba reći da validator prikazuje upozorenja o dupliciranim headerima ili parsirani preview uvezenih redaka.
Najbolji opis ovisi o okolnom tekstu. Ako paragraf već potpuno objašnjava sliku, alt tekst može biti kratak. Ako slika nosi novu informaciju, alt tekst treba pomoći sačuvati tu informaciju.
Spojite alt provjere sa širom Markdown QA provjerom
Nedostajući alt tekst samo je jedan autorski problem među više njih. Dobar preview prolaz treba provjeriti i strukturu naslova, linkove, tablice i code fenceove.
Za širi workflow pročitajte Kako otkriti probleme s Markdownom prije objave. Za timski review koristite Kako product i docs timovi mogu pregledati Markdown bez gubitka formatiranja.
Otvorite validator Markdowna prije objave Markdowna kada su screenshotovi ili dijagrami dio dokumenta.
