18 подписчиков
Почему вашу документацию не читают
Можно написать подробную и точную документацию — и всё равно получать одни и те же вопросы в поддержку.
Чаще всего проблема не в информации, а в том, что текст тяжело читать.
Длинные предложения, перегруженные формулировки и жаргон увеличивают когнитивную нагрузку. Пользователь устаёт ещё до того, как понимает смысл — и закрывает страницу.
Как это измеряют
Чтобы не оценивать тексты «на глаз», используют метрики удобочитаемости. Самые известные — индекс Флеша и Флеша–Кинкейда. Они учитывают:
- среднюю длину предложений;
- сложность слов (по слогам).
Чем короче предложения и проще слова, тем выше удобочитаемость.
Важный нюанс
Эти метрики не оценивают смысл текста — только форму чтения.
Для русского языка применяют адаптированные формулы, но принцип остаётся тем же: они помогают увидеть, где текст перегружен.
Зачем это нужно
Метрики удобочитаемости позволяют:
-находить слишком длинные предложения;
- снижать когнитивную нагрузку;
- делать документацию понятнее без потери смысла.
Удобочитаемость — это часть пользовательского опыта.
Если текст трудно читать, его просто не будут читать.
В статье — формулы, примеры и разбор того, как применять метрики к русскоязычной документации.
1 минута
22 декабря