Nedostajući alt tekst lako je previdjeti u Markdownu jer source i dalje može izgledati kompletno. Sintaksa slike je prisutna, putanja fajla je prisutna i dokument se može renderovati s vidljivim screenshotom. Ono što nedostaje je tekst unutar zagrada.
Technical writeri to trebaju uhvatiti prije objave. Convertyjev Markdown validator može prikazati nedostajući alt tekst zajedno s drugim autorskim upozorenjima, tako da je problem vidljiv dok je source još lako popraviti.
Zašto se nedostajući alt tekst krije u Markdownu
Markdown sintaksa slike izgleda ovako:
Kada opis nedostaje, slika se i dalje može renderovati:
Zato je problem lako propustiti tokom vizuelnog pregleda. Stranica autoru može izgledati dobro, ali source je izgubio koristan kontekst za čitaoce koji zavise od tekstualnih alternativa i za reviewere koji pokušavaju razumjeti ulogu slike.
Provjerite slike tokom preview prolaza
Praktičan docs workflow treba uključiti jedan image-focused review korak:
- Zalijepite Markdown u Markdown validator.
- Pregledajte renderovani preview da potvrdite da se slika prikazuje.
- Pročitajte listu upozorenja za nedostajući alt tekst.
- Vratite se u source i napišite kratak opis koji objašnjava svrhu slike.
- Ponovo provjerite dokument prije objave ili commita.
To je brže od čekanja da reviewer uhvati problem u pull requestu ili objavljenoj stranici.
Dobar alt tekst zavisi od konteksta
Alt tekst treba opisati zašto je slika važna u dokumentu. Screenshot CSV validatora ne treba opisati svaki vidljivi piksel. Možda treba reći da validator prikazuje upozorenja za duple headere ili parsirani pregled uvezenih redova.
Najbolji opis zavisi od okolnog teksta. Ako paragraf već potpuno objašnjava sliku, alt tekst može biti kratak. Ako slika nosi novu informaciju, alt tekst treba pomoći da se ta informacija očuva.
Uparite alt provjere sa širim Markdown QA
Nedostajući alt tekst je jedan autorski problem među nekoliko. Dobar preview prolaz treba provjeriti i strukturu naslova, linkove, tabele i code fenceove.
Za širi workflow pročitajte Kako uhvatiti Markdown probleme prije objave. Za timski review koristite Kako product i docs timovi mogu pregledati Markdown bez gubitka formatiranja.
Otvorite Markdown validator prije objave Markdowna kada su screenshotovi ili dijagrami dio dokumenta.
