Прескокни до главната содржина

Како техничките писатели можат да најдат алт текст што недостасува во Markdown

Од Converty Team

Дознајте како техничките писатели можат да најдат алтернативен текст што недостасува во Markdown пред да се објават документи, датотеки README, белешки за издавање или CMS содржина.

Како техничките писатели можат да најдат алт текст што недостасува во Markdown

Недостасува алтернативен текст е лесно да се занемари во Markdown бидејќи изворот сè уште може да изгледа комплетен. Синтаксата на сликата е присутна, патеката на датотеката е присутна и документот може да се прикаже со видлива слика од екранот. Недостасува текстот во заградите.

Техничките писатели треба да го фатат тоа пред да го објават. Markdown Validator на Converty може да се појави на површина што недостасува алтернативен текст заедно со други предупредувања за авторство, така што проблемот е видлив додека изворот сè уште е лесно да се поправи.

Зошто недостасува алтернативен текст се крие во Markdown

Синтаксата на сликата Markdown изгледа вака:

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

Кога описот недостасува, сликата сè уште може да се прикажува:

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

Тоа го прави проблемот лесно да се пропушти за време на визуелното скенирање. Страницата може да изгледа добро за авторот, но изворот го изгуби корисниот контекст за читателите кои зависат од алтернативите на текстот и за рецензентите кои се обидуваат да ја разберат улогата на сликата.

Проверете ги сликите за време на пропусницата за преглед

Практичниот работен тек на документи треба да вклучува еден чекор за преглед фокусиран на слика:

  1. Залепете го Markdown во Markdown Validator.
  2. Прегледајте го прикажаниот преглед за да потврдите дека сликата се појавува.
  3. Прочитајте ја листата со предупредувања за исчезнатиот алтернативен текст.
  4. Вратете се на изворот и напишете концизен опис што ја објаснува целта на сликата.
  5. Повторно проверете го документот пред да го објавите или обврзете.

Ова е побрзо отколку да чекате рецензент да го открие проблемот во барање за повлекување или објавена страница.

Добриот алтернативен текст зависи од контекстот

Алтернативниот текст треба да опише зошто сликата е важна во документот. На сликата од екранот на валидатор на CSV не му е потребен секој опишан видлив пиксел. Можеби ќе треба да се каже дека валидаторот прикажува дупликати предупредувања за заглавието или анализиран преглед на увезените редови.

Најдобриот опис зависи од околниот текст. Ако параграфот веќе ја објаснува сликата целосно, алтернативниот текст може да биде краток. Ако сликата носи нови информации, алтернативниот текст треба да помогне да се зачуваат тие информации.

Спарете алт проверки со поширока Markdown QA

Недостасува алтернативен текст е едно авторско прашање меѓу неколкуте. Добрата пропусница за преглед исто така треба да ја провери структурата на насловот, врските, табелите и оградите на кодот.

За поширокиот работен тек, прочитајте Како да ги фатите проблемите со означување пред објавување. За тимски преглед, користете How Product and Docs Teams Can Review Markdown Without Losing Formatting.

Отворете го Markdown Validator пред да го објавите Markdown кога сликите од екранот или дијаграмите се дел од документот.

Може да ви се допадне и ова