Гайд: как IT-компаниям быстро делать понятные инструкции о продукте для пользователей

Я Андрей Горелов, главред IT-компании Prodamus. В этой статье расскажу, как мы быстро делаем инструкции о наших продуктах и получаем такие отзывы от сотрудников техподдержки:

Постоянно держите это в голове, когда делаете любой мануал. Инструкции читают люди с разным уровнем навыков: кто-то вчера записался на курсы по компьютерной грамотности, а кто-то программирует очередную нейросеть. Когда приводишь читателей документа к единому знаменателю, писать всегда проще.

Ведь достаточно подробно описывать каждый шаг инструкции скриншотом или скринкастом. Благодаря этому вы не дадите пользователю шанса настроить что-то не так, и ваша техподдержка будет меньше тратить времени на подобные вопросы: «а вот тут вот в инструкции сказано то-то, я не понимаю, куда надо нажать, не получается».

👉 Пример инструкции

Скриншот или скринкаст на каждый шаг это означает именно каждый шаг. Даже если пользователю нужно нажать две кнопки рядом или интуитивно понятно, куда нужно нажать:

Область, где нужно что-то нажать или ввести, затемняйте, чтобы пользователь быстро сообразил, что и где нужно сделать:

👉 Как делать скриншоты с затемнениями

Это даже не инфостиль, а бабкостиль (да, простят меня пенсионеры, я заранее извиняюсь) где важно подробно и последовательно объяснять, что нужно делать. Инструкция должна быть похожа примерно на это: «Ба, вот сюда нажми, потом появится снизу слева красная иконка, вот туда жми, затем появится меню, вот там введи то-то и то-то».

❌ Ой, милок, я не поняла ничего

Чтобы выйти из платёжной страницы, нажмите на кнопку внизу. Затем нажмите на «Сохранить», потом сформируйте ссылку на тестирование оплаты.

✅ Спасибо тебе, дай бог тебе здоровья и невесту красивую

Чтобы выйти с платёжной страницы, нажмите внизу на иконку с открытым замком.Затем нажмите на «Сохранить», потом сформируйте ссылку на тестирование оплаты. Для этого нажмите «Создать ссылку» в левом нижнем углу экрана.

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

👉 Пример

👉 Как делать скринкасты

Это нужно, чтобы не делать инструкцию слишком длинной или не копировать по 100 раз в неё фрагменты других инструкций:

Снимать видеоинструкцию просто. Зайдите в Zoom или Skype, включите запись звонка и на демонстрации экрана покажите, что и где нужно нажать, залейте её на YouTube или соцсети, потом вставьте в ваш хелп. Можно добавить на монтаже логотип и обложку видео, ил идаже музыку на фон без авторских прав.

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

Делайте инструкции для людей, которые не умеют пользоваться ПК. Учитывайте, что инструкции читают люди с разным уровнем навыков кто-то вчера записался на курсы по компьютерной грамотности, а кто-то программирует очередную нейросеть. Когда приводишь читателей документа к единому знаменателю, писать всегда проще.
Делайте скриншоты на каждый шаг инструкции. Даже если пользователю нужно нажать две кнопки рядом или интуитивно понятно, куда нужно нажать. Область, где нужно что-то нажать или ввести, затемняйте, чтобы пользователь быстро сообразил, что и где нужно сделать.
Пишите текст последовательно и подробно. Представьте, что рассказываете своей бабушке, как что-то настроить в телефоне: «Ба, вот сюда нажми, потом появится снизу слева красная иконка, вот туда жми, затем появится меню, вот там введи то-то и то-то»
Делайте скринкасты для мини-инструкций. Это нужно, если в вашей инструкции есть повторяющиеся экраны с дополнительными настройками, которые можно сделать в 2-3 клика.
На повторяющиеся пункты инструкции делайте активные ссылки. Иначе вашу инструкцию разнесет на 100500 экранов
Дублируйте текстовые инструкции видеоинструкциями. Кому-то удобно читать, а кому-то смотреть