Saknad alternativ text är lätt att förbise i Markdown eftersom källan fortfarande kan se komplett ut. Bildsyntaxen finns, filsökvägen finns och dokumentet kan återges med skärmdumpen synlig. Det som saknas är texten inom parentes.
Tekniska skribenter bör fånga det innan de publicerar. Convertys Markdown Validator kan visa saknad alt-text tillsammans med andra författarvarningar, så problemet är synligt medan källan fortfarande är lätt att åtgärda.
Varför saknas alt-text gömmer sig i Markdown
Markdown bildsyntax ser ut så här:
När beskrivningen saknas kan bilden fortfarande återges:
Det gör det lätt att missa problemet under en visuell skanning. Sidan kan se bra ut för författaren, men källan har tappat användbar kontext för läsare som är beroende av textalternativ och för granskare som försöker förstå bildens roll.
Kontrollera bilder under förhandsgranskningen
Ett praktiskt dokumentarbetsflöde bör innehålla ett bildfokuserat granskningssteg:
- Klistra in Markdown i Markdown Validator.
- Granska den renderade förhandsgranskningen för att bekräfta att bilden visas.
- Läs varningslistan för saknad alt-text.
- Gå tillbaka till källan och skriv en kortfattad beskrivning som förklarar bildens syfte.
- Kontrollera dokumentet igen innan du publicerar eller binder.
Detta är snabbare än att vänta på att en granskare ska fånga problemet i en pull-begäran eller publicerad sida.
Bra alt-text beror på sammanhanget
Alternativ text ska beskriva varför bilden är viktig i dokumentet. En skärmdump av en CSV-validator behöver inte varje synlig pixel som beskrivs. Det kan behöva sägas att valideraren visar dubbletter av rubrikvarningar eller en tolkad förhandsvisning av importerade rader.
Den bästa beskrivningen beror på den omgivande texten. Om stycket redan förklarar bilden fullt ut, kan alt-texten vara kort. Om bilden innehåller ny information, bör alt-texten hjälpa till att bevara den informationen.
Para ihop alt-checkar med bredare Markdown QA
Att sakna alt-text är en författarfråga bland flera. Ett bra förhandsvisningspass bör också kontrollera rubrikstruktur, länkar, tabeller och kodstängsel.
För det bredare arbetsflödet, läs Hur man får tag på Markdown-problem före publicering. För teamgranskning, använd Hur produkt- och dokumentteam kan granska markdown utan att förlora formatering.
Öppna Markdown Validator innan du publicerar Markdown när skärmdumpar eller diagram är en del av dokumentet.
