Понятность и доступность

Заголовок должен помогать человеку решить, относится ли страница к его вопросу.

Хороший заголовок:

• конкретен;
• понятен без внутреннего контекста;
• использует язык задачи;
• не обещает больше, чем даёт материал.

Лучше:

Что подготовить до разработки сайта

чем:

Подготовительный этап

Лучше:

Что делать, если сайт не открывается

чем:

Решение технических проблем

H1 описывает всю страницу. H2 должны позволять понять структуру даже при беглом просмотре.

Не используйте постоянные заголовки «Важно», «Полезно», «Информация» без предмета.

Чек-лист: можно ли понять тему по одному заголовку; отвечает ли он реальному запросу; не является ли внутренним термином организации.

Кнопка должна говорить, что произойдёт после действия.

Хорошо:

• Посмотреть условия участия
• Скачать CSV
• Открыть источник
• Перейти на сайт проекта

Плохо:

• Подробнее
• Здесь
• Нажать
• Продолжить, когда непонятно куда

CTA не должен обещать действие, которое недоступно. При закрытом приёме нельзя писать «Получить решение» или «Подать заявку».

Текст ссылки должен оставаться понятным вне окружающего предложения – это важно и для доступности.

Не заменяйте один сложный термин другим сложным термином.

При первом появлении объясните смысл обычным языком и только затем используйте короткую форму.

Например:

Соглашение об уровне сервиса (SLA) – отдельные договорные условия о доступности и времени реакции.

Не нужно объяснять общеизвестные слова, но внутренние сокращения и профессиональный жаргон лучше раскрывать.

Если термин встречается на многих страницах, создайте словарную запись и связывайте с ней материалы.

Сначала удаляйте не факты, а повторения и вводные обороты.

Порядок сокращения:

1. убрать повтор одной мысли; 2. заменить длинную конструкцию прямой; 3. перенести детали в отдельный блок; 4. превратить реальный перечень в список; 5. убрать внутреннюю историю, не нужную пользователю.

Нельзя сокращать так, чтобы исчезали ограничения, источник, период, условие или важное «не входит».

Короткий текст не всегда лучше. Цель – минимальный объём, достаточный для правильного решения.

Длинная страница должна позволять читать последовательно и выборочно.

Используйте:

• ясное введение;
• блок «Коротко»;
• смысловые H2;
• содержание «На этой странице» для действительно длинных материалов;
• примеры;
• чек-лист или итог;
• следующий шаг.

Не прячьте критичную информацию в accordion только ради сокращения страницы.

Каждый крупный раздел должен быть полезен даже при переходе по якорной ссылке.

Список – когда элементы равноправны.

Таблица – когда нужно сравнить одинаковые свойства нескольких объектов.

Обычный текст – когда важны логика и причинная связь.

Не превращайте длинные абзацы в таблицу из двух колонок только ради дизайна. Не превращайте весь материал в bullets – связность исчезает.

После ответа на вопрос человек должен понимать, куда идти дальше.

Следующим шагом может быть:

• следующее руководство;
• источник;
• действующая версия документа;
• связанная тема;
• решение Qaz Support, если оно действительно соответствует задаче.

Не превращайте каждый материал в рекламную воронку к заявке.

Alt описывает не файл, а смысл изображения в контексте.

Если изображение декоративное – пустой alt.

Если это скриншот, опишите важную функцию, а не каждый пиксель.

Для графика достаточно описать предмет и период; точные значения должны быть доступны таблицей.

Не используйте имя файла как alt.

Ссылка должна оставаться понятной, если прочитать её отдельно.

Лучше:

Методика расчёта показателя

чем:

Подробнее здесь

Если ссылка внешняя и это важно для контекста, обозначьте внешний переход доступным способом.

На странице один H1. H2 – главные разделы, H3 – подразделы.

Не выбирайте уровень заголовка по размеру шрифта.

Правильная структура помогает людям, поиску и экранным дикторам понимать документ.

Хорошее сообщение отвечает:

1. что произошло; 2. что человек может сделать дальше.

Например:

Не удалось скачать файл. Попробуйте ещё раз или откройте страницу набора данных.

Пустой поиск не означает, что информации не существует. Говорите только о результате текущего поиска.