Відсутній заміщуючий текст легко не помітити в Markdown, оскільки джерело може виглядати повним. Синтаксис зображення присутній, шлях до файлу присутній, і документ може відображатися з видимим знімком екрана. Відсутня частина — це текст у дужках.
Технічні автори повинні вловити це перед публікацією. Converty Markdown Validator може виводити відсутній альтернативний текст разом із іншими авторськими попередженнями, тож проблему видно, хоча джерело все ще легко виправити.
Чому відсутній альтернативний текст ховається в Markdown
Синтаксис зображення Markdown виглядає так:
Якщо опис відсутній, зображення може відтворюватися:
Це дозволяє легко пропустити проблему під час візуального сканування. Сторінка може виглядати добре для автора, але джерело втратило корисний контекст для читачів, які залежать від альтернативних текстів, і для рецензентів, які намагаються зрозуміти роль зображення.
Перевірте зображення під час попереднього перегляду
Практичний робочий процес із документами має включати один етап перегляду, орієнтований на зображення:
- Вставте Markdown у Markdown Validator.
- Перегляньте відтворений попередній перегляд, щоб переконатися, що зображення з’являється.
- Прочитайте список попереджень про відсутність тексту заміщення.
- Поверніться до джерела та напишіть стислий опис, що пояснює призначення зображення.
- Повторно перевірте документ перед публікацією або фіксацією.
Це швидше, ніж чекати, поки рецензент виявить проблему в запиті на отримання або опублікованій сторінці.
Хороший альтернативний текст залежить від контексту
Альтернативний текст має описувати, чому зображення має значення в документі. Знімок екрана валідатора CSV не потребує опису кожного видимого пікселя. Можливо, знадобиться сказати, що валідатор показує повторювані попередження заголовка або проаналізований попередній перегляд імпортованих рядків.
Найкращий опис залежить від навколишнього тексту. Якщо абзац уже повністю пояснює зображення, альтернативний текст може бути коротким. Якщо зображення містить нову інформацію, альтернативний текст має допомогти зберегти цю інформацію.
Поєднайте перевірки альтернатив із ширшою перевіркою якості Markdown
Відсутність альтернативного тексту є однією з проблем авторства. Хороший попередній перегляд також повинен перевірити структуру заголовків, посилання, таблиці та кодові огорожі.
Щоб дізнатися більше про робочий процес, прочитайте Як виявити проблеми з уцінкою перед публікацією. Для командного перегляду скористайтеся Як команди продукту та документів можуть переглядати розмітку без втрати форматування.
Відкрийте Markdown Validator перед публікацією Markdown, якщо знімки екрана або діаграми є частиною документа.
