Недавно меня попросили написать инструкцию к виар-проекту. Клиент предположил, что пользователи будут путаться во время первого запуска.
Такое означает, что приложение могли перегрузить функционалом. Например, добавили много новых для пользователя функций, с которыми сложно разобраться. Отсюда появился запрос на справку.
При организации проектов хорошо работает плавное погружение в виар. Подсказки появляются локально, в тех местах, где у пользователя могут возникнуть проблемы. Для этого проводится тестирование на взгляд новичка.
Если, всё же, пришлось писать справку, то рекомендую сделать это в соответствии с принципами пирамиды Минто.
Принципы пирамиды Минто
Эти принципы помогают при структурировании и организации информации. Документация, созданная по этим правилам помогает пользователям быстро и легко найти нужную информацию. Об этих принципах расскажу далее.
Начните с ответа
Первый принцип пирамиды заключается в том, чтобы важную информацию размещать в самом начале документации. Пользователи открывают справку когда что-то сломалось, или приложение не работает. Они будут искать ответ на конкретный вопрос и решение возникшей проблемы. Поэтому вводную часть следует сделать минимальной и сразу вести к основной части.
Группируйте информацию
Второй принцип пирамиды рекомендует разделить информацию на группы или разделы. Каждый из разделов посвятите обзору функций, настроек, решению возможных проблем.
Используйте заголовки
Этот принцип плавно вытекает из предыдущего. Если информация сгруппирована в разделы, обозначьте ясными информативными заголовками. Например, заголовок «Хранение личных данных» будет вести в раздел, посвящённый вопросам сбора и хранения информации о пользователях.
Делайте списки
Четвёртый принцип – используйте списки для перечисления шагов, настроек или функций. Это поможет пользователям легко просмотреть и понять информацию.
Будьте конкретными
По пятому принципу избегайте лишних слов, которые могут запутать пользователя. Будьте конкретны в справке и используйте простой и понятный язык. Чтобы пользователю было легко следовать инструкциям. Избегайте длинных предложений по этой же причине.
Делайте информацию доступной
Шестой заключительный принцип состоит в том, что справка должна быть доступна пользователям. Внутри программы – в виде подсказок и отдельного текста. А также можно добавить справку на внешний ресурс, сделать её доступной в интернете.
Заключение
Применение принципов пирамиды Минто поможет написать структурированный и понятный документ, который будет полезен пользователям. Время, потраченное на структурирование справки обернётся скоростью поиска информации.
Начинайте сразу с самого главного. Опишите проблему, которую решит инструкция. Упрощённая структура каждого раздела может выглядеть таким образом:
- Проблема
- Возможная причина
- Решение
- Примеры
Желаю удачи с написанием справки!