Puuduvat alternatiivteksti on Markdownis lihtne kahe silma vahele jätta, kuna allikas võib siiski täielik välja näha. Kujutise süntaks on olemas, failitee on olemas ja dokument võidakse renderdada koos ekraanipildiga. Puuduv osa on sulgudes olev tekst.
Tehnilised kirjutajad peaksid sellest enne avaldamist aru saama. Converty Markdown Validator võib kuvada puuduva alternatiivteksti koos muude autoriseerimishoiatustega, nii et probleem on nähtav, kui allikat on endiselt lihtne parandada.
Miks puudub alternatiivne tekst Markdownis peidus
Markdowni pildi süntaks näeb välja selline:
Kui kirjeldus puudub, saab pilti siiski renderdada:
See muudab visuaalse skannimise ajal probleemist kergesti märkamata. Leht võib autorile hea tunduda, kuid allikas on kaotanud kasuliku konteksti lugejate jaoks, kes sõltuvad tekstialternatiividest, ja arvustajate jaoks, kes püüavad mõista pildi rolli.
Kontrollige pilte eelvaate läbimise ajal
Praktiline dokumentide töövoog peaks sisaldama ühte pildile keskendunud ülevaatuse sammu:
- Kleepige allahindlus Markdown Validatorisse.
- Pildi ilmumise kinnitamiseks vaadake üle renderdatud eelvaade.
- Lugege puuduva alternatiivteksti hoiatuste loendit.
- Naaske allika juurde ja kirjutage lühike kirjeldus, mis selgitab pildi eesmärki.
- Enne avaldamist või sidumist kontrollige dokumenti uuesti.
See on kiirem kui oodata, kuni ülevaataja tõmbab tõmbetaotluses või avaldatud lehel probleemist aru.
Hea alternatiivtekst sõltub kontekstist
Alternatiivne tekst peaks kirjeldama, miks pilt on dokumendis oluline. CSV-validaatori ekraanipilt ei vaja kõiki kirjeldatud piksleid. Võib-olla tuleb öelda, et validaator näitab dubleerivaid päise hoiatusi või imporditud ridade sõelutud eelvaadet.
Parim kirjeldus sõltub ümbritsevast tekstist. Kui lõik juba selgitab pilti täielikult, võib alternatiivtekst olla lühike. Kui pilt sisaldab uut teavet, peaks alternatiivtekst aitama seda teavet säilitada.
Ühendage alternatiivsed kontrollid laiema Markdowni kvaliteedikontrolliga
Puuduv alternatiivtekst on üks autoriprobleem mitme hulgas. Hea eelvaate pass peaks kontrollima ka pealkirja struktuuri, linke, tabeleid ja koodipiirdeid.
Laiema töövoo jaoks lugege artiklit Kuidas enne avaldamist märkimisprobleeme tabada. Meeskonna ülevaatamiseks kasutage rakendust Kuidas toote- ja dokumentide tiimid saavad vaadata allahindlust ilma vormingut kaotamata.
Avage Markdown Validator enne Markdowni avaldamist, kui ekraanipildid või diagrammid on dokumendi osa.
