Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

Существуют разные причины, по которым требуется написать руководство пользователя системы. Начиная с просьб заказчика (в моей практике был случай, когда заказчику надо было поставлять руководство пользователя после каждой итерации, чтобы с его помощью он смог бы провести приемочное тестирование функциональности итерации) и заканчивая условиями контракта, касающимися поставки готового ПО, если говорить о разработке ПО на заказ. В случае разработки собственного продукта написание руководства пользователя тоже часто имеет место.

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

Ниже я приведу несколько практик для составления хорошего руководства пользователя. Часть из них, возможно, кому-то будут полезны и при написании спецификаций требований.

1. Стандарты

Часто бывает нужно написать документ, который бы удовлетворял требованиям действующих стандартов. Это могут быть:

• IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
• ГОСТ 19:
  • ГОСТ 19.402-78 ЕСПД. Описание программы;
  • ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

Также может оказаться полезной книга Юрия Кагарлицкого MetaGuide. Руководство для разработчиков технической документации к программному обеспечению.

2. Структура

Хорошо продумайте структуру документа: она должна покрывать все функциональные возможности системы, быть полной и понятной.

Хорошее руководство пользователя должно содержать:

• Аннотацию , в которой приводится краткое изложение содержимого документа и его назначение. Также рекомендуется писать краткую аннотацию в начале каждого крупного раздела.
• Введение , содержащее информацию о том, как лучше всего использовать данное руководство
• Содержание
• Главы , описывающие, как использовать ПО
• Глоссарий и
• Предметный указатель

Также руководство пользователя может содержать:

• FAQ и ответы на них
• Ссылки на дополнительную информацию по системе
• Раздел , описывающий возможные проблемы и пути их решения

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

3. Пользователи

Подумайте о типичных пользователях данного ПО: необходимо, чтобы документ помогал им решать их насущные задачи.

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

Помните, что стиль изложения в устной речи или в деловом письме отличается от оного в технической документации, и в частности, в руководстве пользователя.

Стиль руководства должен быть нейтрально-формальным – использование стилистически окрашенных слов отвлекает пользователя от сути.

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

4.1 Пишите кратко и логично. Не давайте лишних деталей, не дублируйте информацию. Последовательность упоминания информации в руководстве пользователя должна совпадать с последовательностью действий пользователя:

Хорошо : In File menu, select Save item .
Хуже : Select Save item from File menu.

4.2 Используйте повелительное наклонение , не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо : Click Logout .

Хуже : It is needed to click Logout to log out current user account from the system.

Хуже : If user wants to log out current user account from the system(s)he needs to click Logout.

4.3 Структурируйте информацию. Часто можно встретить совет, что надо стараться избегать списков, однако, структурированная по шагам информация всегда лучше воспринимается.

Хорошо:
To create project :

1. Click the Create button on toolbar.
2. On the Create Project overlay fill in all mandatory fields.
3. Click the Save button to save the project.

Хуже : To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время . Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо : When user clicks the Start button, the program starts the process.

Хуже : When user clicks the Start button, the program will start the process.

4.5 Проверяйте значение слов. Если необходимо писать документ на иностранном языке, надо стараться максимально избегать ошибок, связанных с недостаточным знанием языка.

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

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

4.7 Разумно используйте сокращения и исключите жаргон .

Считается, что сокращения использовать не стоит, но если длинный термин употребляется несколько раз, то при первом упоминании в тексте надо писать полное название и рядом — аббревиатуру в скобках, а далее по тексту можно использовать только аббревиатуру. Если в документе есть глоссарий или раздел с сокращениями, они должны быть там расшифрованы.

Не используйте жаргонные слова, метафоры и термины, заимствованные из языка отличного от языка руководства.

5. Внешний вид

5.1 Продумайте стиль документа . Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

При написании не стесняйтесь выделять важные вещи стилями или цветами (например, названия кнопок выделять жирным шрифтом). Но важно понимать, что неправильно подобранные шрифты и цвета могут затруднить восприятие содержимого документа.

5.2 Не экономьте место – разбивайте текст на короткие абзацы, используйте сравнительно крупные заголовки, начинайте новый раздел с новой страницы. Это облегчит восприятие прочитанной пользователем информации.

5.3 Используйте пиктограммы и иллюстрации . Существует мнение, что не стоит увлекаться иллюстрациями, а также включать в текст пиктограммы (icons) в руководстве пользователя. Однако графическая информация всегда лучше воспринимается и запоминается, поэтому снимки экрана и нужные пиктограммы должны присутствовать в хорошем руководстве в достаточном, но разумном количестве.

6. Поддержка

Не упускайте из виду тот факт, что ПО со временем меняется, а значит, ваш документ тоже должен меняться, чтобы оставаться актуальным.

Заключение

Примите к сведению, что раздражение от некачественного документа может быть спроецировано пользователем на ПО и, тем самым, повлиять на решение использовать продукт.

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества сайт,

аналитик с 6-летним опытом в сфере.

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

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

Да что там таблетки и техника! Зайдите в простой супермаркет, возьмите в руки упаковку с макаронными изделиями. Что вы увидите на обратной стороне? Не своеобразную ли инструкцию по использованию?!

Вот здесь и начинается все самое интересное…

Характер подачи информации кардинально разнится. Иногда, кажется, что в наши руки попало секретное послание спецслужб, расшифровать которое не представляется возможным, или наоборот - взрослым людям объясняют почти на пальцах, сколько будет два плюс два.

Удобство и простота использования товара всегда являлись весомыми «рычагами» влияния на принятие ЦА решения о покупке.

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

Сумели завуалировать ее непонятными терминами? Тогда получайте «в награду» отказ от покупки и радость своих конкурентов, которые предоставили клиентам адекватную, четкую и понятную инструкцию, демонстрирующую - с нашим планшетом легко «подружиться».

Написание качественного руководства по эксплуатации товара - это целое искусство. Давайте приоткроем занавес и заглянем «за кулисы» его создания.

Итак, на что же стоит обратить внимание при составлении руководства по эксплуатации, которое будет «работать» на продажи?

Детализация

Конкретика и степень детализации - те параметры, которые определяются согласно уровню подготовленности ЦА. Здесь выбирается оптимальный баланс, ориентированный на потенциального покупателя.

Например:

После нажатия ____ появляется приветственное окно.

После нажатия ____ в ____ углу клавиатуры на экране появляется приветственное окно с надписью «____».

Чаще всего встречаются инструкции, содержащие в себе более детальную информацию. Но будьте осторожны! Не стоит доводить детализацию до абсурдности и чрезмерности, иначе вы рискуете разозлить и потерять клиента:

После нажатия пальцем клавиши ____ в правом верхнем углу клавиатуры на экране появляется приветственное окно с темно-синей надписью «____», расположенной посередине.

Структурирование

Мы неоднократно рассказывали о важности структурирования информации в текстах. Такая подача облегчает восприятие материала аудиторией. Не является исключением и руководство по эксплуатации.

Сравните:

1. Вставьте диск в дисковод.
2. В появившемся окне нажмите ____.
3. Выберите пункт меню ____.

Вставьте диск в дисковод, затем в появившемся окне нажмите ____, и уже после этого выберите пункт меню ____.

В первом варианте мы видим пошаговое структурирование информации. Четко, легко и понятно. Иначе выглядит и воспринимается второй вариант - он более «тяжеловесный».

Позитив и корректность

Думаете, это не важно? Ошибаетесь! Для позитивного результата нужно мыслить позитивно и говорить позитивно посредством текста с ЦА (да простят нас ярые противники тавтологии).

Никто не любит хамства и унылости. Поэтому настраивайте деликатно и очень корректно потенциальных покупателей ТОЛЬКО на позитив.

Вот как это выглядит на практике:

Достаньте монитор из коробки и аккуратно освободите его от упаковки. Придерживайте со всех сторон, чтобы сохранить его целостность.

Достаньте монитор из коробки и освободите от упаковки. Постарайтесь в процессе его не уронить и не разбить.

НЕТ трем «С»: сокращениям, синонимам и сомнениям

При составлении инструкции по использованию товара желательно избегать любой «интонационной неуверенности». Смело вычеркивайте различные «пожалуй, наверное, возможно».

Сокращения допустимы лишь в том случае, если в самом начале руководства была приведена полная формулировка, возле которой указывалась ее «сжатая форма»:

Транспортная компания (ТК) отвечает ____.

Многофункциональное устройство (МФУ) работает ____.

Операционная система (ОС) запускается ____.

Неприемлемо использование синонимов и жаргонов. Не нужно «красоваться» своей эрудицией и запутывать пользователей разной терминологией.

Если речь идет, например, о мобильном телефоне, то не стоит применять по тексту инструкции такие слова, как «мобильник», «мобила», «телефонный аппарат», «сотовый телефон» и т.д.

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

Да здравствует повелительное наклонение!

Используйте повелительное наклонение - побуждайте пользователей к действию (призывайте, советуйте, предупреждайте, запрещайте).

Сравните:

Для включения телефона нужно нажать на ____.

Кнопка ____ отвечает за включение телефона.

Нажмите ____, чтобы включить телефон.

Включите телефон с помощью кнопки ____.

Последний штрих

Хуже всего, если человек ввиду «путаного руководства» не смог понять, как пользоваться товаром, и отказался от его приобретения. Поэтому…

После того, как готовая инструкция закрепилась на «экранном листе» монитора нажатием кнопки «сохранить», не лишним будет проверить - понятна ли она вашей ЦА.

Мы не занимаемся написанием «словесных полотен» с простым описанием ряда необходимых действий, а разрабатываем четкие, логичные и наглядные руководства.

Руководства по использованию, которые стимулируют пользователей к покупке.

Статьи-инструкции… Их любят и читатели, и заказчики, и веб-авторы.

Нам заказали серию статей-инструкций!

Читатели за исчерпывающее руководство и решение проблем, заказчики- за растущую лояльность читателей и повышение собственной экспертности. А веб-авторы за простоту написания этих статей для сайтов и востребованность на рынке.

Правда, есть один минус.

Инструкция должна быть написана по правилам и учитывать все особенности этого вида статей. Готовы узнать все правила, особенности и нюансы?

Тогда начинаем…в формате инструкции, конечно. 🙂

Шаг №1 С чего начать написание статьи-инструкции для сайта

Конечно, с теории. Прежде чем писать, нужно понять, как это делать. Вы ведь помните, что правильные фрирайтеры пишут правильные статьи? 🙂

Правила написания статьи-инструкции:

1. Статья должна быть полезной

Главное в статьях - польза!

Ведь главная задача инструкции - решить проблему читателя.

Если читателю нужно срочно решить вопрос или в сети мало информации, то он прочтет даже серую статью, без форматирования и картинок. Лишь бы понять, что делать.

Но это совсем не значит, что можно писать инструкции без акцентов и списков.

Вы же хотите, чтобы ваш доход как копирайтера рос? Тогда и статьи должны быть цепляющие и аппетитные.

А чтобы польза была →

2. Инструкция должна быть подробной

А выполнить это правило написание статьи можно лишь в одном случае: если вы когда-нибудь делали то, что описываете. Тогда вы затронете нюансы, дадите советы и убережете от ошибок.

Отсюда вывод→

3. Инструкция должна быть экспертной

Как измерить удава - задача для эксперта

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

Зато читатель, который зависнет на каком-нибудь пункте, точно внесет ваш сайт в «черный список» или напишет гневный отзыв. И вместо лояльности получите сплошной негатив.

Поэтому еще одно правило написания статьи →

4. Инструкция должна быть наглядной

Используйте фотографии, видеоролики, скриншоты, иллюстрации. Главное, чтобы читателю было предельно ясно и понятно .

Не забывайте про списки и подзаголовки.

Как это, забыли про списки и картинки?

Очень удобно, когда каждый шаг выделяется отдельным подзаголовком. В таком случае информация выглядит структурировано и легко.

Шаг №2 Определяем круг тем для написания статей-инструкций

Сложно найти темы, которые НЕ подходят для этого вида статей.

Медицина, юриспруденция, кулинария, рукоделие, ремонт, воспитание детей - на любую тему можно написать инструкцию.

К примеру, «Как вылечить сухой кашель у детей», «5 этапов составления иска», «Пошаговый рецепт приготовления настоящего дифлопе с крутоном», «Исчерпывающее руководство по эксплуатации суповарки».

Что делать, если вы «не в теме»?

Вариантов всего три:

• выбирать для написания статей темы, в которых разбираетесь

Например, если вы мама, которая решила найти достойный заработок в декрете - пишите на детскую тематику или выберите то, что вам интересно: ваши увлечения, профессия до декрета и т.д.

• писать на основе опыта заказчика

Например, заказчик устанавливает скинали. Он делится с вами опытом, корректирует статьи или дополняет их случаями из собственной практики.

• приобрести нужный опыт

Не будем писать на незнакомые темы

Да, приготовить дифлопе, установить палатку, написать статью-инструкцию. Правда, это возможно только в том случае, если тема для написания статей интересна и перспективна.

Вряд ли стоит затевать весь сыр-бор ради единственной инструкции. У вас ведь наверняка есть масса других увлечений и знаний, не так ли?

Шаг№3 Выбираем вид статьи-инструкции

Удивлены? Озадачены? Да, видов инструкций несколько, а точнее четыре:

• простая пошаговая инструкция
• инструкция-практикум
• инструкция с предварительной постановкой проблемы
• инструкция-перевертыш

Простая пошаговая инструкция

Подходит, если читатель прекрасно осведомлен о существовании проблемы и хочет ее решить.

Поэтому достаточно уделить пару абзацев самой проблеме, а основную часть статьи посвятить поэтапному решению.

Инструкция-практикум

Подробная инструкция в формате мастер-класса, иногда в видеоформате или со множеством фотографий.

К примеру: «Как сшить маскарадный костюм для девочки» или «Как научиться ставить цели».

Инструкция с предварительной постановкой проблемы

Я еще не закончил говорить о проблеме

Если тема для вашей аудитории новая , то стоит уделить особое внимание постановке проблемы: до 30-50% всего текста.

Ведь аудитория может и не подозревать о том, что у нее есть проблема.

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

Инструкция-перевертыш

Подходит, если вы хотите рассказать о нескольких проблемах или ошибках.

Например, «10 ошибок фрилансера-новичка» или «5 основных причин крушения семей в России».

Причем в этом виде статьи акцент смещен с инструкции на проблему , которая подается в негативном свете .

Шаг №4 Составляем план написания статьи-инструкции

К сожалению или к счастью, хорошую статью без плана не напишешь.

Тезисно запишите все пункты плана написания статьи, сделайте пометки, если нужна дополнительная информация, цифры или факты.

А как же план, извините, пожалуйста?

• Начните с цели статьи

Что вы хотите рассказать читателям? Какую проблему решить? Что посетители сайта должны сделать ПОСЛЕ прочтения?

• Теперь приступайте к заголовку

Чаще всего для инструкций выбираются заголовки, релевантные запросам аудитории.

Это заголовки, которые начинаются со слова как : «Как выбрать корм для щенка чау-чау» или «Как написать эффектный заголовок для коммерческого предложения»

Если вы даете в статье ответ на вопрос, то вопросительный знак в заголовке НЕ ставится.

Еще один вариант - использование цифр : «12 шагов для успешной сдачи экзамена» или «5 этапов подготовки к идеальной свадьбе».

• Теперь очередь лида

Очертите проблему, зацепите читателя, заинтригуйте, подарите надежду.

Читатель должен понять, что эта статья для него и он найдет ответ на свой вопрос.

• Основная часть инструкции

Для обычной инструкции подробно распишите все шаги, необходимые для решения проблемы.

Если вы решили написать статью с постановкой проблемы - тщательно рассмотрите проблему со всех сторон.

Если вы пишите инструкцию-перевертыш, то учтите, что каждый пункт - это и описание проблемы, и причины ее появления, и пути решения. Как говорится «всё в одном флаконе».

• Подытожьте

В конце сделайте выводы, подводите итоги и обязательно заставьте читателя действовать . Вы же помните про цель вашей статьи?

Шаг № 5 пишем инструкцию

А теперь краткие тезисы плана написания статьи превратите в развернутый подробный аргументированный рассказ.

Всё, ваша инструкция готова.

Осталось только её проверить и отправить заказчику. Кстати, для этой цели очень удобно использовать чек лист. Он поможет вовремя заметить и исправить ошибки.

Где отработать технику написания статей для сайтов?

Просто ли писать инструкции? Это зависит от практики. Чем больше практики, тем проще писать статьи.

Но как практиковаться, если не умеешь писать статьи? Под контролем опытных тренеров на статейном марафоне .

Тренироваться нужно под присмотром!

Там не только учат, как писать статьи шести видов , составлять контент-план, подбирать ключи и линковать статьи, но и дают тренироваться на самых настоящих заказчиках, у которых есть работающий бизнес и которые платят вам за статьи.

Такие заказчики заинтересованы в долгосрочном сотрудничестве, так что возможно вы найдете себе клиентов надолго.

Готовы практиковаться на реальных клиентах под присмотром четырех успешных экспертов? Тогда добро пожаловать на статейный марафон!

А пока расскажите, умеете ли вы писать статьи-инструкции? Все ли виды инструкций вам приходилось писать? Какие фишки вы используете при написании статей-инструкций для сайтов?

Получите удобный инструмент оценки качества статьи

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

Шаги

Часть 1

Подготовка к написанию инструкции

Изучите свою целевую аудиторию. Это первое, что нужно сделать при написании инструкции. Для кого вы пишете? Эти люди эксперты или новички? Знание аудитории помогает вам правильно подбирать слова, использовать необходимую степень детализации и методику структурирования информации.

• Например, если вы объясняете как испечь торт профессиональному шеф-повару, то вам нет необходимости объяснять как перемешивать ингредиенты, почему важно довести яйца до комнатной температуры или разницу между обычной и блинной мукой. Если же вы объясняете это тем, кто не умеет готовить, наличие этих определений и пояснений может повлиять на вкус готового торта.
• Лучше проявите излишнюю осторожность и не относитесь к аудитории как к экспертам. Тогда ваши инструкции будут понятными и их легко будет соблюдать.

1. Укажите все необходимые инструменты. Прежде чем начать, вы должны четко перечислить, что требуется для успешного выполнения инструкции. Это может быть список ингредиентов или необходимого инвентаря.

   Выполните задачу. Лучший способ написать полезную инструкцию – самому проделать процесс выполнения задачи. Таким образом вы запишете все подробности. Если вы будете восстанавливать процесс по памяти, вы можете не вспомнить все детали. Затем найдите того, кто выполнит задачу по вашим записям. Пусть они прокомментируют любые странные или непонятные действия, упомянутые в тексте.

   • Будьте внимательны и не упустите ничего. Если вы пропустите важные шаги, то читатель не сможет выполнить задание. Также убедитесь, что все действия указаны в правильном порядке.
   • Например, если вы говорите «Перемешайте ингредиенты миксером. Поместите в духовку, разогретую до температуры 350 градусов», читатель может подумать, что вы помещаете миску для смешивания в духовку.

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

   • В определениях или объяснениях старайтесь использовать краткие конструкции.
   • Например, скажите «Добавьте два яйца» вместо «В тесто для торта следует добавить два яйца».

3. Добавляйте только необходимую информацию. Когда добавляете дополнительную информацию, убедитесь, что используете только необходимое. Спросите себя: «Нужно ли читателю знать это определение, чтобы понимать инструкцию?» или «Нужен ли читателю этот совет для успешного выполнения инструкции?»

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

4. Используйте обращения. Текст инструкции следует составлять как разговор с читателем. Для этого используйте слово «вы». С ним вы лично проведете читателя через все пункты.

   Будьте конкретны. Инструкция должна быть предельно конкретной. Пишите только о том, что необходимо знать. Указывайте, в какую сторону поворачивать ключ, сколько ног используется при ходьбе или как должен выглядеть готовый торт.

   • Приводите точные величины. Если кому-то нужно отрезать 7,8 см от доски, так и говорите.
   • Например, при составлении кулинарного рецепта не ждите до четвертого этапа, чтобы сказать: «Перед тем как смешивать ингредиенты, просейте муку и нагрейте яйца до комнатной температуры.»

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

   • Некоторые вводные слова: во-первых, далее, затем, наконец, после, прежде.

Часть 3

Структура инструкции

1. Напишите вводную часть. Прежде чем приступить к подробным инструкциям, необходимо кратко ввести читателя в курс дела. Во введении объясняется, что читатель сможет сделать после прочтения инструкции. В нем также содержится обзор всех действий. Оно должно быть кратким и доходчивым.

   Расположите свои инструкции в порядке необходимости. Инструкции составлены из последовательных взаимосвязанных действий. Перед тем как сесть за написание инструкции, вы должны решить, какие шаги являются необходимыми. То есть вам нужно выбрать то, без чего нельзя начать выполнение поставленной задачи.

   Разбейте инструкцию на отдельные задачи. В большинстве инструкций для успешного завершения всего процесса необходимо выполнить несколько задач. Организация инструкции в форме отдельных пунктов для каждого этапа поможет легко читать и понимать ее.

   Четко маркируйте каждую задачу. Для того, чтобы помочь читателю понять инструкцию, отмечайте каждый ее раздел понятными словами. Заголовок задачи должен включать в себя то, чему посвящена конкретная задача или ее часть. Читатель должен понять задачу, которую будет выполнять, прежде чем приступит к ней.

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

   • Если этап включает в себя смежное действие, которое должно быть завершено в нем же, последовательно объясните действие в том же предложении. Например, «Перед заливкой торта в форму покройте поверхность кастрюли жидкостью от пригорания» или «Покройте поверхность кастрюли жидкостью от пригорания. Затем залейте торт в форму.»

2. Предоставьте возможность отслеживать успех выполнения этапов. Важной особенностью полезной инструкции является помощь читателю в отслеживании их выполнения. Это может выглядеть так: «Когда вы ___________, вы увидите _________».

   • Например, «Когда торт будет сделан, воткните по центру зубочистку. Если зубочистка окажется чистой, значит, торт готов».

3. Укажите, по возможности, какие-нибудь альтернативы. Иногда то же самое можно сделать несколькими способами. Убедитесь, что объяснили все возможные способы, которыми действие может быть выполнено.

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

   Поместите предупреждения и условия в начале. Если есть вещи, которые читатель должен знать, сделать или понять, прежде чем начать выполнение задачи, убедитесь, что вы начали описание этапа именно с этих вещей.

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

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

Создавая новый продукт (онлайн-сервис, интернет-магазин, мобильное приложение), мы стараемся обеспечить надежность, быстродействие и безопасность продукта. Чтобы выделиться на фоне конкурентов, мы рисуем необычный дизайн, добавляем новые фишки в интерфейс. Опираясь на собственный опыт, считаем, что пользователям будут понятны все нововведения.

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

Почему после запуска проекта ожидания не равны результатам

Наблюдения за продвижением разных онлайн-сервисов показывают практически одинаковые результаты. Если после запуска сервиса опросить первых 100 пользователей, мы получим примерно такую картину:

• 40 человек не воспользуются сервисом, пока не ознакомятся с инструкциями, скриншотами и видеозаписями, созданными консультантами сервиса. За инструкциями они будут обращаться в техподдержку;
• 20 человек самостоятельно ознакомятся с инструкциями, изучат функции сервиса;
• еще 20 не поймут с чего начать работу и не воспользуются сервисом;
• только 10 пользователей выполнят все настройки правильно, не буду читать инструкции и обращаться в службу технической поддержки;
• оставшиеся 10 человек оценивали сервис, сравнивали его с конкурентами, пока не решили, будут ли его использовать.

Большинство пользователей не разбираются в функциях и навигации онлайн-сервиса; 40% пользователей не читают инструкции на сайте и обращаются за помощью к консультантам. Лишь 10% приступают к работе с сервисом без дополнительной помощи, поскольку имеют необходимый пользовательский опыт .

Как сделать сервис более понятным

Известный специалист в области юзабилити Якоб Нильсен утверждает, что “система должна быть равным образом приемлема для двух групп пользователей - новичков и опытных” (принцип гибкости и эффективности, одно из “10 эвристических правил дизайна пользовательского интерфейса”).

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

Если новички не разбираются в работе сервиса без инструкций и обращения в техподдержку, найдите способ объяснить им, как правильно пользоваться системой. Для начала, проанализируйте, что именно непонятно людям, какие вопросы они задают. Затем напишите четкие инструкции и расставьте в нужных местах подсказки.

О чем спрашивают начинающие пользователи

Новые пользователи задают два вопроса:

1. С чего начать, чтобы пользоваться сервисом? (пользователь плохо понимает сервис) .
2. Как выполнить ту или иную задачу? (не понимает последовательности действий, сценария работы) .

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

• Пользователь не нашел инструкцию.
• Пользователь не разобрался в многостраничной документации.

Якоб Нильсен еще в 1995 году сформулировал правило: “лучше всего, если системой можно пользоваться, не читая документацию, но при необходимости нужно обеспечить справочную информацию, которая не должна быть слишком объёмной и должна предлагать список конкретных действий”.

Предоставьте пользователям доступные и понятные инструкции

В “10 эвристических правилах дизайна пользовательского интерфейса” Якоба Нильсена содержится целый ряд рекомендаций и правил по оформлению пользовательских инструкций.

Мы адаптировали эти советы.

Хорошая справочная статья	Плохая справочная статья
Содержит четкие описания шагов, которые приведут пользователя к цели	Предлагает пользователю самостоятельно определить проблему и выбрать решение из списка
Предлагает инструкции для решения только текущей задачи Нажмите «ОК» и ваше письмо уйдет адресату	Содержит список советов, относящихся к данному этапу работы с системой: Чтобы написать письмо - нажмите «Создать» Чтобы удалить письмо - нажмите «В Корзину» Чтобы отправить письмо - нажмите «ОК»
Размещена на видном месте, появляется, если пользователь зашел на сайт и 10 секунд не выполняет никаких действий	Спрятана в разделе «Помощь по сайту», который никто не читает
Умещается в нескольких предложениях	Содержит много страниц и ссылок

Правила американского юзабилиста дополняет российский специалист, автор книги “Shareware: профессиональная разработка и продвижение программ” Станислав Жарков:

“При описании пути решения проблемы, как и при написании любой документации, нужно избегать составления слишком объемных текстов, т. к. пользователи будут просто пробегать их глазами, не вникая в смысл написанного, подобно тому, как человек, просматривающий газету, сначала останавливает взгляд на коротких заметках, пропуская большие материалы. Лучше всего составить что-то наподобие пошаговой инструкции, каждый шаг из которой составляет 1—2 предложения” (“Shareware: профессиональная разработка и продвижение программ”, СПб., 2001).

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

Создаем инструкции с помощью подсказок

Мы посмотрели на реакцию пользователей, записали и изучили их вопросы, определили непонятные им функции. Для каждого непонятного момента создадим краткие подсказки.

Известные компании, например, Google и Facebook, помогают пользователям подсказками. Вы встречали их, если создавали на Facebook страницу компании или работали с текстом в Google Docs.

А это пример подсказки для пользователей Google Plus .

Краткие инструкции в подсказках обращают внимание пользователей на новые или дополнительные функции. Система автоматически показывает их новым пользователям в начале работы. Они отображаются лишь один раз, их можно закрыть (пропустить), либо перейти в справочный раздел ресурса и прочитать больше. Чтобы объяснить последовательность действий, разработчики сервисов объединяют такие подсказки в демо-туры. Подобные инструкции предлагают своим пользователям Google Plus и Youtube.

Чек-лист для разработки эффективной инструкции в форме подсказок

1. Опишите подсказками конкретные шаги пользователей.

2. Создайте обучающие туры для сценариев работы.

3. Объясните подсказками назначение сложных функций и специальных терминов.

4. Подскажите пользователям, как ускорить выполнение часто повторяющихся действий.

5. Показывайте подсказки автоматически только один раз, при первом посещении пользователя.

6. Разрешите пользователю включать демо-туры в любой момент.

7. Оформите подсказки в едином для сервиса дизайне.

Инструменты для создания подсказок

Для создания одностраничных инструкций (для одного окна интерфейса) подходят готовые библиотеки кода Java Script: Intro.js и Bootstro.js . Для создания кросс-страничных подсказок подойдут сервисы Hintarea и Walkme.com .

Подсказки могут помочь тем, кто:

• установил новое мобильное приложение;
• воспользовался онлайн-сервисом (системой бронирования, доской объявлений);
• оформляет заказ в интернет-магазине;
• работает с бизнес-приложением (CMS, CRM).

Пример: подсказки для обучения пользователей CMS Wordpress

Представим типичную ситуацию. Веб-студия разработала сайт и передала его компании-владельцу. Наполнять сайт контентом будет менеджер компании. Скорее всего, он не имеет серьезного опыта работы с CMS (пусть в нашем примере это будет WordPress). Панель администрирования вызовет у него ряд вопросов:

• с чего начать работу;
• что означают названия и термины;
• где найти справочную информацию;

Веб-студия сильно упростит клиентам работу с сайтом, если заранее создаст для них подсказки в сложных местах.

Можно придумать десятки подсказок и объединить их в демо-туры, чтобы не заставлять пользователя пролистывать страницы документации или просматривать видео-уроки. Чтобы понять, какие бывают подсказки, напишем пояснения к ключевым задачам.

Объясним пользователю, с чего начинать

Пользователь нажимает на кнопку “Добавить новую”. Появляется окно редактирования новой страницы и следующая подсказка.

Научим правильно заполнять формы

Обратим внимание на важные функции

Формируем понимание работы с контентом

Объясним специальные термины

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

Еще раз о пользе

Ценность подсказок для пользователей очевидна - те, кому раньше требовалась помощь, осваивают сервис или приложение самостоятельно.

Разработчики приложений или сервисов сэкономят на подготовке и публикации технической документации и справочных материалов. Подсказки снизят нагрузку на службу техподдержки.

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

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

Это перевод статьи, ранее опубликованной в американском журнале для интернет-предпринимателей sandhill.com.

Специально для онлайн-издания “ПроГрабли” материал значительно расширен, главным образом за счет включения информации по аспектам UX-дизайна при разработке веб-продукта.