Przejdź do głównej treści

Jak autorzy tekstów technicznych mogą znaleźć brakujący tekst alternatywny w Markdown

Autor: Converty Team

Dowiedz się, jak autorzy tekstów technicznych mogą znaleźć brakujący tekst alternatywny w Markdown przed opublikowaniem dokumentów, plików README, informacji o wersji lub treści CMS.

Jak autorzy tekstów technicznych mogą znaleźć brakujący tekst alternatywny w Markdown

Brakujący tekst alternatywny można łatwo przeoczyć w Markdown, ponieważ źródło może nadal wyglądać na kompletne. Obecna jest składnia obrazu, ścieżka pliku jest obecna, a dokument może zostać wyświetlony z widocznym zrzutem ekranu. Brakującą częścią jest tekst w nawiasach.

Autorzy tekstów technicznych powinni to zrozumieć przed publikacją. Weryfikator Markdown firmy Converty może wyświetlić brakujący tekst alternatywny wraz z innymi ostrzeżeniami o autorze, dzięki czemu problem jest widoczny, a jego źródło jest nadal łatwe do naprawienia.

Dlaczego brakujący tekst alternatywny ukrywa się w Markdown

Składnia obrazu Markdown wygląda następująco:

![Useful description](/path/to/image.png)

Jeśli brakuje opisu, obraz może być nadal renderowany:

![](/path/to/image.png)

Dzięki temu problem łatwo przeoczyć podczas skanowania wizualnego. Strona może wyglądać dobrze dla autora, ale źródło straciło użyteczny kontekst dla czytelników, którzy polegają na alternatywach tekstowych, oraz dla recenzentów próbujących zrozumieć rolę obrazu.

Sprawdź obrazy podczas podglądu

Praktyczny obieg dokumentów powinien obejmować jeden etap przeglądu skoncentrowanego na obrazie:

  1. Wklej Markdown do Markdown Validator.
  2. Przejrzyj wyrenderowany podgląd, aby upewnić się, że obraz się pojawia.
  3. Przeczytaj listę ostrzeżeń dotyczącą brakującego tekstu alternatywnego.
  4. Wróć do źródła i napisz zwięzły opis wyjaśniający przeznaczenie obrazu.
  5. Sprawdź ponownie dokument przed publikacją lub zatwierdzeniem.

Jest to szybsze niż czekanie, aż recenzent wychwyci problem w żądaniu ściągnięcia lub na opublikowanej stronie.

Dobry tekst alternatywny zależy od kontekstu

Tekst alternatywny powinien opisywać znaczenie obrazu w dokumencie. Zrzut ekranu walidatora CSV nie wymaga opisu każdego widocznego piksela. Może zaistnieć potrzeba poinformowania, że ​​walidator wyświetla zduplikowane ostrzeżenia nagłówka lub przeanalizowany podgląd zaimportowanych wierszy.

Najlepszy opis zależy od otaczającego tekstu. Jeśli akapit już w pełni wyjaśnia obraz, tekst alternatywny może być krótki. Jeśli obraz zawiera nowe informacje, tekst alternatywny powinien pomóc zachować te informacje.

Połącz kontrole alt z szerszą kontrolą jakości Markdown

Brakujący tekst alternatywny to jeden z wielu problemów autorskich. Dobra przepustka podglądowa powinna również sprawdzić strukturę nagłówków, linki, tabele i ogrodzenia kodu.

Więcej informacji na temat szerszego przepływu pracy można znaleźć w artykule Jak wykryć problemy związane z przecenami przed publikacją. Do przeglądu zespołowego użyj Jak zespoły ds. produktów i dokumentów mogą przeglądać przeceny bez utraty formatowania.

Otwórz Weryfikator Markdown przed opublikowaniem Markdown, gdy zrzuty ekranu lub diagramy stanowią część dokumentu.

Może Ci się też spodobać