TL;DR или почему не читают вашу документацию (и что с этим делать)
Что сделать, чтобы ваша инструкция не превратилась в скучный лонгрид? Как заинтересовать пользователя? Делимся набором простых правил, который поможет сделать вашу документацию интересной и читаемой для любой целевой аудитории.
Всем привет! Мы – команда технических писателей Manuscript. И да, мы написали статью на 6к символов про то, как делать тексты короче.
Понимание нового формата мышления: что хотят от документации?
Из-за большого объема входящей информации каждый день, люди постепенно привыкли к более быстрому, лёгкому формату её восприятия. Короткие видео, инфографики, сжатые пояснения – так выглядит привычный контент, и с ним легко начать «пролистывать» длинные и сложные материалы в информационном потоке.
По этой причине традиционная документация с её массивными текстами вызывает у многих скуку и отзыв в духе “TL;DR” (англ. too long; didn't read – слишком длинно, не читал). Чтобы быть полезной и легко читаемой, документация должна соответствовать современным стандартам и предлагать простые, сжатые форматы.
А можно ли вообще соблюсти этот баланс информативности и простоты? Да! Вот несколько ключевых принципов:
- Соблюдайте краткость и упрощайте язык. Убирайте все лишние вводные фразы и ненужные детали, говорите проще. Технический язык часто превращает документацию в инструкции по ракетостроению.
- Используйте мультимедиа. Подчёркивайте важные блоки и делайте акценты на ключевых моментах с помощью схем и инфографик, чтобы они не терялись в общем тексте.
- Разбивайте информацию на блоки. Краткие параграфы, визуальные разделения – всё это улучшает восприятие.
- Прислушивайтесь к пользователю. Собирайте фидбек по вашей документации, чтобы адаптировать её под интересы и нужды читателя.
Эти простые шаги помогут не только уменьшить объём текста, но и распределить его составляющие так, чтобы его было легче усвоить и не потерять интерес. Далее обо всём по порядку.
Краткость – сестра таланта: сокращаем объём без потери смысла
Поговорим о ключевом качестве хорошей документации – лаконичность. Коротко – не значит бедно по содержанию. Часто документация изобилует деталями, которые не дают пользы. Чтобы сократить текст без потерь, начните с выделения того, что действительно необходимо знать пользователю.
Советы по сокращению:
- Избавьтесь от канцеляризмов и вводных слов. «Было бы полезно обратить внимание…» можно заменить на «Обратите внимание».
- Используйте активный залог. Последовательность "субъект–действие–объект" привычнее для чтения и делает текст живым и более динамичным. Вместо «Работа была сделана мной» можно написать «Я сделал работу».
- Приводите понятные примеры. Одно простое сравнение с чем-то из повседневной жизни заменит несколько абзацев с подробным описанием. Так, технологию блокчейн часто объясняют на примере бисерного ожерелья, где каждая бусинка – это блок, который «нанизывают» на уже существующую цепочку.
Краткость в документации – это не только сокращение объёма, но и эффективное представление информации.
Наглядность и мультимедиа: один график вместо тысячи слов
Документация – это не только текст. Видео, GIF и инфографики помогают донести информацию проще и быстрее, чем длинные пояснения. Особенно это касается технических аспектов, где один наглядный ролик может заменить десятки строк текста.
Примеры мультимедийных форматов для документации:
- Видеоуроки. Это могут быть короткие видеоролики, разбитые на шаги.
- GIF-анимации. Полезны для объяснения простых действий, например, настройки интерфейса или повторяющихся действий.
- Инфографика и схемы. Они сразу показывают, как организована работа или куда нажать.
Используя мультимедиа, не забывайте об оптимизации: выберите форматы, которые действительно улучшат восприятие, а не усложнят его. Сейчас полно инструментов, позволяющих создавать яркие, информативные, акцентные элементы мультимедиа. Например, мы в своей команде используем Notion, Canva, Figma и множество других сервисов.
Адаптация под восприятие «с ходу»
Документация должна быть доступной для быстрого «сканирования». Короткие блоки текста, лёгкие для восприятия заголовки и простая навигация помогают пользователю найти ответ «с ходу», не углубляясь в дебри.
Чтобы адаптировать текст для быстрого восприятия:
- Используйте структурирование. Делайте заголовки и подзаголовки, разбивайте длинные абзацы на смысловые блоки. Прямо, как в этой статье :)
- Задействуйте списки. Списки позволяют структурировать шаги и упростить восприятие.
- Создавайте интуитивную навигацию. Навигационные ссылки и оглавление помогут пользователю быстро находить нужные разделы.
Проиллюстрируем удачное и не очень оформление документации на примере простой инструкции.
Вариант 2, в отличие от Варианта 1, имеет четкую последовательность и уместные визуальные подсказки для наглядности, а потому он легок для восприятия и ориентирования.
Экспериментируйте и собирайте фидбек
Собирайте обратную связь и наблюдайте, какие части документации пользователи читают, а какие пропускают. Настройте аналитику, чтобы видеть, где именно пользователи проводят больше времени или где чаще всего возникают вопросы.
Подсказки по сбору фидбека:
- Опросы и комментарии. Оставьте форму обратной связи, чтобы пользователи могли выразить мнение и предложить улучшения.
- Аналитика. Используйте инструменты вроде Google Analytics для анализа поведения пользователей.
- Тестирование и A/B-тесты. Пробуйте разные форматы и анализируйте, какой лучше воспринимается.
- Пасхалки. Сделайте интерактивные кнопки, если формат позволяет, или вставьте маленькие картинки в неожиданном месте (можно мемные, но не злоупотребляйте). Так вы проверите по реакции, читали ли вообще ваш документ.
Помните, что любая система документации – вещь не статичная. Она может и должна меняться, подстраиваясь под новые тренды и нужды пользователей.
Заключение
Создание документации, адаптированной под новые ожидания, – это путь к лояльности пользователей, а также повышению интереса и снижению числа вопросов к вашему продукту. Адаптируйте свою документацию под постоянно меняющиеся тренды, добавляйте наглядность и собирайте обратную связь, чтобы повысить её ценность. Так ваш продукт станет более доступным и понятным для аудитории, готовой к быстрой и лёгкой информации.