Как создать полезное руководство пользователя
Написание руководства пользователя может стать настоящим вызовом из-за сложности продукта или процесса, а также из-за технического языка, который не всегда понятен обычному пользователю. В этой статье представлено 10 советов по созданию четкого и лаконичного руководства.
Автор статьи — контент-редактор в EPAM Фрэнк Вольтас.
Введение
Что первым делом делают многие люди, вернувшись домой из ИКЕА? Да, они игнорируют инструкции и сразу же начинают собирать мебель. У одних это может сработать, но у других это приводит к выяснению отношений или полному разочарованию.
В профессиональной сфере люди часто используют один и тот же подход, когда речь идет об использовании продукта или услуги. Задача авторов состоит в том, чтобы создавать руководства пользователя, которые были бы информативными, удобными и в то же время располагали к прочтению.
В этой статье я расскажу о лучших практиках, которые помогут вам написать более качественное руководство пользователя.
10 советов о том, как создать полезное руководство пользователя
1. Подумайте, кто ваша аудитория
Прежде чем написать на бумаге хоть одно слово, подумайте, кто ваша аудитория. Для кого вы пишете это руководство? Каков уровень образования этих людей, кем они работают, что, возможно, уже знают об этом? Владеют ли они языком, на котором вы пишете? Адаптация руководства под конкретные потребности целевой аудитории обеспечит его доступность, увлекательность и легкость его восприятия.
2. Ознакомьтесь с продуктом или услугой
Это может показаться очевидным, но прежде чем приступить к написанию, следует убедиться, что вы знакомы с продуктом или услугой на практике. Или хотя бы поспрашивать у людей, которые знакомы, попросить их выделить важные темы.
3. Структурируйте содержание
Содержание руководства пользователя должно быть логично структурировано. Возможно, имеет смысл выделить общую часть, предназначенную для всех пользователей, а затем в отдельных разделах или связанных документах предоставить дополнительную целенаправленную, более подробную информацию для продвинутых пользователей.
4. Используйте четкий и лаконичный язык
Поставьте себя на место вашей аудитории, пишите так, чтобы информацию легко было воспринимать и интересно читать. Старайтесь избегать длинных абзацев, вместо этого используя маркеры или нумерованные списки. Язык должен быть как можно более простой, повседневный, а также стоит избегать жаргона.
5. Добавьте подробные инструкции
У пользователей должна быть возможность следовать инструкциям шаг за шагом, поэтому излагайте их достаточно подробно. Если существует несколько способов выполнения задачи, то во избежание путаницы лучше описать только самый простой из них. Дополнительную информацию для опытных пользователей можно вынести в отдельные разделы или связанные документы.
6. Уделите внимание оформлению и визуальным средствам
Оформление руководства пользователя должно быть привлекательным и последовательным. Этому способствуют четкий шрифт, умеренное и логичное использование цветов, отказ от слишком длинных абзацев.
Хорошая визуализация, например таблица или скриншот, может стоить тысячи слов. Используйте визуальные средства для иллюстрации своих тезисов и комментарии для предоставления пошаговых инструкций.
7. Создайте раздел FAQ
Создайте список часто задаваемых вопросов и ответов, который пользователи легко найдут.
8. Обеспечьте проверку и обновление
Позаботьтесь, чтобы перед публикацией руководства пользователя его вычитали коллеги и, желательно, один или несколько представителей целевой аудитории. Откорректируйте его в соответствии с замечаниями.
После публикации обязательно регулярно пересматривайте и обновляйте руководство. Мало что так раздражает пользователей, как неполная или устаревшая документация.
9. Добавьте глоссарий и алфавитный указатель
Если при этом объем руководства не выйдет за допустимые границы, включите в него оглавление и алфавитный указатель. Оглавление помогает пользователям понять структуру документа и легко найти интересующую их тему. Алфавитный указатель может быть полезен, если руководство пользователя большое.
10. Продвигайте ваше руководство
Можно создать отличное руководство пользователя, но если им никто не пользуется, то какой в этом смысл? Делайте акцент на его существовании на сайтах, в информационных рассылках и во время тренингов.
Заключение
«Ни у кого нет на это времени» — так многие думают о чтении руководств пользователя. Я не питаю иллюзий, что ситуация когда-нибудь полностью изменится. Но с помощью советов, приведенных в этой статье, вы сможете написать хорошее руководство, которым люди будут пользоваться с удовольствием. Это поможет свести к минимуму количество обращений в службу поддержки и обеспечит пользователям положительный опыт.