Fehlender Alt-Text kann in Markdown leicht übersehen werden, da die Quelle immer noch vollständig aussehen kann. Die Bildsyntax ist vorhanden, der Dateipfad ist vorhanden und das Dokument wird möglicherweise mit sichtbarem Screenshot gerendert. Der fehlende Teil ist der Text in den Klammern.
Technische Redakteure sollten sich darüber im Klaren sein, bevor sie etwas veröffentlichen. Der Markdown Validator von Converty kann fehlenden Alternativtext zusammen mit anderen Autorenwarnungen anzeigen, sodass das Problem sichtbar ist, während die Quelle noch leicht zu beheben ist.
Warum fehlender Alternativtext in Markdown ausgeblendet wird
Die Markdown-Bildsyntax sieht folgendermaßen aus:
Wenn die Beschreibung fehlt, kann das Bild trotzdem gerendert werden:
Dadurch kann das Problem bei einem visuellen Scan leicht übersehen werden. Für den Autor sieht die Seite vielleicht gut aus, aber die Quelle hat ihren nützlichen Kontext für Leser verloren, die auf Textalternativen angewiesen sind, und für Rezensenten, die versuchen, die Rolle des Bildes zu verstehen.
Überprüfen Sie die Bilder während des Vorschaudurchgangs
Ein praktischer Dokumenten-Workflow sollte einen bildorientierten Überprüfungsschritt umfassen:
- Fügen Sie den Markdown in den Markdown Validator ein.
- Überprüfen Sie die gerenderte Vorschau, um sicherzustellen, dass das Bild angezeigt wird.
- Lesen Sie die Warnliste für fehlenden Alt-Text.
- Kehren Sie zur Quelle zurück und schreiben Sie eine kurze Beschreibung, die den Zweck des Bildes erläutert.
- Überprüfen Sie das Dokument erneut, bevor Sie es veröffentlichen oder festschreiben.
Dies ist schneller, als darauf zu warten, dass ein Prüfer das Problem in einem Pull-Request oder einer veröffentlichten Seite erkennt.
Guter Alternativtext hängt vom Kontext ab
Alternativtext sollte beschreiben, warum das Bild im Dokument wichtig ist. Für einen Screenshot eines CSV-Validators müssen nicht alle sichtbaren Pixel beschrieben werden. Möglicherweise muss gesagt werden, dass der Validator Warnungen zu doppelten Headern oder eine analysierte Vorschau der importierten Zeilen anzeigt.
Die beste Beschreibung hängt vom umgebenden Text ab. Wenn der Absatz das Bild bereits vollständig erklärt, kann der Alternativtext kurz sein. Wenn das Bild neue Informationen enthält, sollte der Alternativtext dazu beitragen, diese Informationen zu bewahren.
Kombinieren Sie Alt-Checks mit einer umfassenderen Markdown-QA
Fehlender Alt-Text ist eines von mehreren Problemen beim Verfassen. Ein guter Vorschaudurchgang sollte auch die Überschriftenstruktur, Links, Tabellen und Code-Zäune überprüfen.
Für den umfassenderen Arbeitsablauf lesen Sie So erkennen Sie Markdown-Probleme vor der Veröffentlichung. Verwenden Sie für die Teamüberprüfung Wie Produkt- und Dokumententeams Markdown überprüfen können, ohne die Formatierung zu verlieren.
Öffnen Sie den Markdown Validator, bevor Sie Markdown veröffentlichen, wenn Screenshots oder Diagramme Teil des Dokuments sind.
