Puuttuva vaihtoehtoinen teksti on helppo jättää huomiotta Markdownissa, koska lähde voi silti näyttää täydelliseltä. Kuvan syntaksi on olemassa, tiedostopolku on olemassa ja asiakirja voidaan renderöidä niin, että kuvakaappaus näkyy. Puuttuva osa on suluissa oleva teksti.
Teknisten kirjoittajien tulisi saada se kiinni ennen julkaisemista. Convertyn Markdown Validator voi tuoda esiin puuttuvan vaihtoehtoisen tekstin muiden luontivaroitusten ohella, joten ongelma on näkyvissä, kun lähde on edelleen helppo korjata.
Miksi puuttuva vaihtoehtoinen teksti piiloutuu Markdownissa
Markdown-kuvan syntaksi näyttää tältä:
Kun kuvaus puuttuu, kuva voidaan silti hahmontaa:
Tämä tekee ongelman helposti huomaamatta visuaalisen skannauksen aikana. Sivu saattaa näyttää hyvältä kirjoittajan silmissä, mutta lähde on menettänyt hyödyllisen kontekstin lukijoille, jotka ovat riippuvaisia tekstivaihtoehdoista, ja arvioijille, jotka yrittävät ymmärtää kuvan roolia.
Tarkista kuvat esikatselun aikana
Käytännön asiakirjojen työnkulkuun tulisi sisältyä yksi kuvakeskeinen tarkistusvaihe:
- Liitä merkintä Markdown Validatoriin.
- Tarkista hahmonnettu esikatselu varmistaaksesi, että kuva tulee näkyviin.
- Lue puuttuvan vaihtoehtoisen tekstin varoitusluettelo.
- Palaa lähteeseen ja kirjoita ytimekäs kuvaus, joka selittää kuvan tarkoituksen.
- Tarkista asiakirja uudelleen ennen julkaisemista tai sitomista.
Tämä on nopeampaa kuin odottaa, että arvioija havaitsee ongelman vetopyynnössä tai julkaistussa sivulla.
Hyvä vaihtoehtoinen teksti riippuu kontekstista
Vaihtoehtoisen tekstin tulee selittää, miksi kuvalla on merkitystä asiakirjassa. CSV-validaattorin kuvakaappaus ei tarvitse kaikkia kuvattuja näkyviä pikseleitä. Sen on ehkä sanottava, että tarkistaja näyttää päällekkäisiä otsikkovaroituksia tai tuotujen rivien jäsennetyn esikatselun.
Paras kuvaus riippuu ympäröivästä tekstistä. Jos kappale selittää kuvan kokonaan, vaihtoehtoinen teksti voi olla lyhyt. Jos kuva sisältää uutta tietoa, vaihtoehtoisen tekstin pitäisi auttaa säilyttämään tiedot.
Yhdistä vaihtoehtotarkistukset laajempaan Markdown QA:han
Puuttuva vaihtoehtoinen teksti on yksi tekijä useiden joukossa. Hyvän esikatselun tulee tarkistaa myös otsikkorakenne, linkit, taulukot ja koodiaidat.
Laajempi työnkulku on artikkelissa Kuinka havaita merkintäongelmia ennen julkaisua. Tiimiarviointiin käytä Kuinka Product and Docs Teams Can Review Markdown menettämättä muotoilua.
Avaa Markdown Validator ennen kuin julkaiset Markdownin, kun kuvakaappaukset tai kaaviot ovat osa asiakirjaa.
