Руководство пользователя. Советы для составления
Существует множество видов предоставления справочной информации пользователю – это и 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 to log out current user account from the system.
Хуже: 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:- Click the Create button on toolbar.
- On the CreateProject overlay fill in all mandatory fields.
- Click the Savebutton 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. Поддержка
Не упускайте из виду тот факт, что ПО со временем меняется, а значит, ваш документ тоже должен меняться, чтобы оставаться актуальным.
Заключение
Примите к сведению, что раздражение от некачественного документа может быть спроецировано пользователем на ПО и, тем самым, повлиять на решение использовать продукт.
Помните главное: документ должен помогать пользователям.
Статью подготовила
Тарасюк Надежда, участник сообщества analyst.by,
аналитик с 6-летним опытом в сфере.
Как написать руководство
Чтобы объяснить человеку как выполнять задачу или работать с инструментом, нужно составить понятную инструкцию. Неизвестная компьютерная программа или новые функции на работе – все это требует разъяснений для успешного взаимодействия. В статье рассмотрим, как правильно написать инструкцию.
Инструкция – это документ, который объясняет способы или правила выполнения определенных действий. А понятная инструкция делает то же самое, но простым языком. Многие руководства написаны очень сложно и люди предпочитают не заглядывать в них, пока что-то не сломается. Однако такой подход может привести к не самым лучшим последствиям. Например, работник не изучил правила по работе на буровой установке или неверно понял описанный материал, и получил травму из-за неправильного использования техники. Поэтому важно ответственно подойти к составлению и разобраться, как правильно написать инструкцию.
3 основных вида инструкций
Есть несколько типов инструкций. Они предназначены для разных целей, но разрабатываются по схожим принципам. К примеру – уяснив, как написать инструкцию по работе системного администратора, вы легко сможете применить эти знания и при подготовке руководства по использованию мини-АТС.
Пошаговая инструкция
Такие руководства позволяют регламентировать все возможные повторяющиеся процессы. Поставленная задача разбивается на несколько этапов, и каждый этап дополняется пояснениями. Примеры таких инструкций – пошаговые алгоритмы составления бухгалтерской отчетности, подключение к удаленному рабочему столу или действия при пожаре.
- Откройте верхнюю крышку и извлеките блок фотобарабана
- Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
- Вытащите тонер-картридж
- Поставьте на его место новый
- Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
- Установите фотобарабан обратно в принтер
- Закройте крышку
- Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает – обратитесь к системному администратору
Инструкция по использованию
Это перечень рекомендаций по правильному использованию приборов, например, руководство к сканеру штрих-кодов. Такие мануалы будут полезны пользователям непростых устройств — на рабочем месте или в быту.
В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:
- В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic – 160-180°C.
- Максимальное время работы ламинатора – 4 часа. Затем нужно сделать получасовой перерыв.
- Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его.
- Внимание! Не ламинируйте влажные образцы – жидкость может повредить электронные компоненты!
- После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством.
- Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию!
Должностная инструкция
Так называют документ, регулирующий сферу обязанностей для конкретной должности. Также здесь определены права работника, требования к квалификации, область ответственности и формы премирования. Должностные инструкции могут быть составлены для любого сотрудника – от уборщицы до генерального директора. Их готовят совместно с юристом.
Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:
- Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
- При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
- Бригадир раздает списки, по которым комплектуются грузы.
- Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
- Если есть необходимость, грузчик может привлекаться к другим работам на территории склада – уборке, контролю за въездом транспорта и пр.
Должностная инструкция – это скорее юридический документ, чем пользовательский. А чтобы понятным языком проинструктировать сотрудника по его работе, обычно составляют отдельное обучение – «Пособие по должности». В нем подробно рассказывают о роли и ценном конечном продукте, описывают систему мотивации, метрики и алгоритмы выполнения работы. И размещают эти материалы на платформе для онлайн-обучения.
Ниже вы можете получить готовую структуру обучения для курса «Пособие по должности».
Общие правила при подготовке инструкций
Для подготовки любого типа руководств используются одни и те же приемы работы с информацией. Вот рекомендации, которые подскажут как написать хорошую инструкцию:
- Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
- Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
- Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
- Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
Как структурировать много данных → - Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта
Алгоритм разработки руководства: 9 шагов
Рассмотрим, как написать доступную инструкцию для сотрудников на примере описания алгоритма действий. Особенность этого руководства в том, что для него нужно не только перечислить отдельные действия, а установить их в правильной последовательности, чтобы привести читателя к нужному результату. В общем случае необходимо:
- Собрать информацию
- Сгруппировать ее по отдельным этапам
- Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя
В качестве примера возьмем ситуацию, когда организация перешла на электронный документооборот. При этом часть сотрудников не умеет работать с программой Microsoft Word и нужно объяснить им, как подготовить заявление о выдаче спецодежды.
Шаг 1. Изучить ситуацию
Конечно, вы не один год используете Word и легко можете подготовить требуемое заявление. Но в данном случае нужно взглянуть на проблему глазами пользователя – человека, который впервые сталкивается с этой программой. Поэтому нужно не опираться на текущие знания по работе в Word, а самостоятельно проделать весь путь заново. С большой вероятностью вы откроете для себя что-то новое – ведь раньше многие операции выполнялись автоматически. Сходу очень трудно вспомнить, как называлась «та кнопка для создания списка» и другие детали.
Шаг 2. Разложить все на отдельные этапы
Задача этого шага – создать предварительный план решения задачи. Такой алгоритм начинается с исходной ситуации и заканчивается достижением результата. В начало каждого пункта поставьте глагол, определяющий ключевое действие этого шага:
- Запустить программу Microsoft Word
- Создать новый документ
- Набрать необходимый текст
- Отформатировать его
- Сохранить файл
- Сообщить в бухгалтерию, что заявление подготовлено
Шаг 3. Описать каждый этап
Здесь нужно конкретизировать каждый шаг, необходимый для достижения поставленной цели. При этом не усложняйте описание. Если действие можно выполнить несколькими способами, опишите только один вариант, максимум два – тогда читатель с меньшей вероятностью запутается.
Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:
2. Нажмите на раздел «Новый документ» в правой части экрана
Если руководство предназначено для новичков, избегайте профессиональной лексики. В нашем примере лучше обойтись без понятий «Интерфейс» и «Строка состояния». Важно понимать, что вы пишете не теоретический учебник для передачи системных знаний, а практическое руководство, по которому человек сможет здесь и сейчас выполнить действия и достичь результата. Если не обойтись без терминов и аббревиатур, поясните их.
Совет. Старайтесь не нагромождать вашу инструкцию ненужными действиями. Например, лишней будет информация о том, какой шрифт использовать для заявления – в большинстве случаев пользователь столкнется с шаблоном Normal, где стоит подходящий Calibri размером 11 пунктов.
Шаг 4. Рассмотреть нестандартные варианты развития ситуации
Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:
3. Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры
Шаг 5. Подобрать изображения и привести примеры
Если можно проиллюстрировать какую-то операцию – обязательно сделайте это. Для рецептов блюд подойдут снимки каждого шага, а для инструкций по сборке – взрыв-схемы (эскизы, на которых вся конструкция разобрана на детали и они разнесены в разные стороны). А чтобы наглядно показать работу в компьютерной программе, следует подготовить скринкасты или скриншоты с пояснениями.
Шаг 6. Придумать заголовок
Даже если вы написали руководство для внутреннего пользования, а не для публикации в интернете, яркий заголовок привлечет внимание и настроит на выполнение нужной работы. Вот несколько вариантов для нашего примера:
- «Как написать инструкцию по подготовке заявления»
- «6 шагов для подготовки электронного документа»
- «Простой способ написать заявление на компьютере»
- «Подробный алгоритм подготовки документа для безбумажного оборота»
Шаг 7. Оценить промежуточный вариант
В результате должен получиться подобный текст:
Как написать простую инструкцию (образец):
- Запустите программу Microsoft Word
- Нажмите на раздел «Новый документ» в правой части экрана
- Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
- Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»
- Сохраните файл. Для этого:
- Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
- Выберите путь сохранения файла
- В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
- Нажмите кнопку «Сохранить»
- Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено.
Пример объявления, на который можете ориентироваться при подготовке:
Шаг 8. Тестирование
Внимательно проверьте инструкцию на логические ошибки. Желательно, чтобы коллеги или знакомые взглянули на нее со стороны. Еще лучше – когда неопытный человек изучает составленный алгоритм и пытается с его помощью добиться желаемого результата.
Проверьте алгоритм с помощью этих вопросов:
- Понятен ли указанный порядок действий? Да, мы улучшали его в шагах 2-5
- Все ли нюансы учтены? Да, последовательность шагов охватывает всю необходимую процедуру
- Есть ли в алгоритме сложные этапы, которые можно разбить на несколько частей? Нет, все они были скорректированы на предыдущих шагах
- Достигнут ли результат? Будет ли он неизменным при разных условиях использования алгоритма? Да, на выходе мы получаем файл для безбумажного оборота. При правильном следовании приведенной последовательности, результата можно достичь вне зависимости от того, кто составляет заявление – грузчик или уборщица
Шаг 9. Обучить сотрудников по инструкции
Если руководство предназначено для сотрудников компании, важно проконтролировать, что они изучили ее. Для этого загрузите инструкцию для персонала на платформу Unicraft, назначьте на нее работника и отслеживайте его прогресс.
Особенности такого обучения:
- Информация сопровождается рисунками, схемами, анимацией, формами обратной связи – это увлекательнее, чем простое чтение текста
- В режиме реального времени руководитель может видеть, какое количество материала уже изучено
- В конце разделов и всего курса предусмотрены контрольные вопросы. Процент правильных ответов для успешного прохождения курса можно задавать самостоятельно (обычно он составляет 80%)
Примеры готовых инструкций
Ниже приведены примеры инструкций по пользованию платформой Unicraft. Нажмите на изображение, чтобы перейти на страницу с руководством.
Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение
Что такое руководство пользователя и для чего его создавать
Ежедневно создаются новые продукты, программы, сервисы и часто пользователям приходится несладко при освоении какой-нибудь сложной программы, поэтому каждому новому продукту желательно собственное руководство. Для чего?
Большинство людей не хочет разбираться с чем-то незнакомым без персонального, всегда доступного и понятного помощника. А именно им и является хорошее руководство пользователя.
Общие советы по созданию пользовательской документации
Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.
После этого важно подумать о том:
- Где пользователь будет к нему обращаться: дома, на работе, в машине?
- Как часто он будет его просматривать?
- Насколько объективно сложен для понимания продукт?
Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.
Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?
Структура руководства пользователя
После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.
В первом разделе желательно рассказать общую информацию о программе:
- Для чего создан продукт.
- Какие задачи он решает.
- Какие основные выгоды от использования для клиента.
В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.
Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.
Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.
Иногда технические писатели забывают о важном моменте в руководстве пользователя — контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Инструменты для быстрого создания руководства пользователя
Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.
Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.
Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.
Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.
При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.
У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.
Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.
Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.
Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.
Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.
Почему компании выбирают Dr.Explain для создания руководств пользователя
Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»
«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.
Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».
Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке
Наталья Обухова, бизнес-аналитик компании CRM Expert
«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.
Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.
Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.
Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».
Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны».
Прочитать полный кейс компании CRM ExpertНиколай Вальковец, разработчик компании 2V
«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».
Прочитать кейс компании V2
Подытожим
Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.
Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/
Успешных вам разработок!
Смотрите также
- Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
- Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
Как написать инструкцию и что делать после ее публикации
Чтобы написать инструкцию, следует выбрать тему, продумать план и структуру, подготовить иллюстрации. Но перед всей этой кропотливой работой вы должны для себя определить – кто в итоге будет читать материал. Для этого придется проанализировать целевую аудиторию и разделить ее представителей на продвинутых и новичков. Для одних будет интересно руководство с использованием профессионального сленга, а другим придется все разжёвывать.
Написанную инструкцию потребуется еще оформить, разбить на главки – шаги, к которым прикрепить фото. Если таковых нет, можно прибегнуть к помощи Ютуба. И после публикации работа не заканчивается. Вам нужно анализировать метрики (сколько человек просмотрели, дочитали и т. д.), общаться с пользователями, отвечать на их вопросы. В общем, предстоит много работы! Но давайте обо все по порядку.
Для чего нужна инструкция
Чтобы любая социальная платформа успешно функционировала и приносила пользователю качественный и регулярный трафик, ему необходимо включить в свой контент интересные материалы. Очень полезны различного рода руководства.
Как же написать качественную инструкцию? Чтобы ответить на этот вопрос, прежде всего надо разобраться с самим определением. Инструкция – это пошаговое руководство, указания и действия, совершаемые в определенном порядке, выполняя которые можно достичь определенной цели. На просторах Интернета можно найти миллионы рекомендаций и ответов по каждому вопросу.
Как написать пошаговую инструкцию – это, скорее всего, вопрос к самому владельцу блога, так все будет зависеть от того, насколько хорошо автор статьи владеет знаниями в той или иной области. Хотя, придерживаясь определенной четкой структуры, практически любой сможет составить развернутое и полезное объяснение в какой-либо теме.
В чем выражается необходимость инструкции? Ответ на вопрос вполне логичен, по крайней мере для читателя, ведь это развернутое объяснение по решению его проблемы, но давайте посмотрим на это со стороны автора. Для самого блогера это один из способов привлечения подписчиков и повышения активности на его страничке, а значит и увеличения потенциальной аудитории. Кроме того, написание инструкции можно рассмотреть с точки зрения копирайтера. Для него это – возможность систематизации и упорядочивания информации, пополнение знаний, ну, и естественно, доход.
Как же надо написать текст инструкции, чтобы он был интересным и просматриваемым? Важно помнить: каким бы профессионалом вы ни были, и как бы ни ориентировались в той или иной теме, ваше руководство прежде всего пишется для простых людей, которые вообще не разбираются в этом направлении (иначе зачем бы им понадобилась инструкция), либо ориентируются в нем очень поверхностно.
Одним словом: то, что планируете писать у себя в блоге, должно быть простым, доступным, информативным, подробным и эффективным. Если инструкция так и не решила проблему читателей, вряд ли вы получите дополнительный поток подписок.
Виды инструкций
В вопросе о видах руководств нет однозначного ответа, как и в том, как правильно написать инструкцию по применению, по эксплуатации, по созданию и т. д. Все дело в том, что одна и та же проблема может быть решена разными способами. Кроме того, манера подачи информации у разных блогеров будет разной. На это влияет не только контент, но и ряд других факторов, например, платформа, на которой эти материалы размещаются, тема, с которой связано руководство, и прочее.
Однако если говорить об инструкциях в целом, можно выделить ряд направлений, которые выделяются из бесконечных классификаций:
- о строительстве чего-либо или же сборке какого-нибудь предмета мебели, процессора и т. д.;
- по применению;
- по принятию лекарственного препарата;
- лайфхак по типу «Как создать/сделать…»;
- кулинарный рецепт.
Перечень не весь, но тут обозначены наиболее популярные и распространенные запросы читателей.
К отдельной категории можно отнести «специфическую инструкцию», или узконаправленную. Речь идет про материалы из разряда:
- пошаговое написание своего романа;
- инструкция по созданию чего-либо в домашних условия, что по своему назначению к этому не подходит;
- порядок действий при нестандартных ситуациях; и т. д.
Любой вид инструкции по своему содержанию может относиться либо к описательным, либо к сценарным. Давайте разберем подробнее.
Описательные
Описательная инструкция, как правило, не несет практического характера, скорее, она рекомендательная. Ее задача рассказать, что из себя представляет объект/услуга, о функциональности, достоинствах и недостатках, возможностях и областях применения, о составе и стоимости. Например:
«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».
Сценарные
Если вашим запросом будет, например, «как написать инструкцию по эксплуатации оборудования», то вам откроются пошаговые действия, которые необходимы для решения проблемы, – это и есть сценарный вид инструкций. Например, как установить картридж в принтер, или как запустить ксерокс и т. д.
Еще один образец того, как можно написать сценарную инструкцию:
«Включите стиральную машину с помощью кнопки СТАРТ. Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».
Как раз-таки и сценарные инструкции, кроме пошаговых действий, могут включать в себя различные лайфхаки, более легкие способы применения, горячие клавиши, профессиональные особенности и приемы. Например, в инструкции установки встроенного шкафа-купе в качестве лайфхака может присутствовать совет о том, что между рельсом и потолком из гипсокартона необходимо проложить фанеру, это не даст креплению ослабнуть при длительном использовании.
Для понимания различия: обзор функций нового выпущенного смартфона – описательная, инструкция по поклейке обоев – сценарная.
Кроме того, формат инструкций может быть:
- текстовым;
- видео;
- скринкастингом – запись всех действий с экрана компьютера или смартфона;
- инфографичным – каждый этап сопровождается фотографиями;
- голосовым;
- FAQ – сервис по часто задаваемым вопросам.
Каждый формат нужно подбирать к соответствующей проблеме. Если вы говорите о программном обеспечении или о деятельности, которую необходимо совершать за компьютером, то подойдет скринкастинг. Инфографика уместна для пошаговых действий типа способа приготовления блюда или сборки мебели. Голосовые, текстовые и видеоформаты способны объединить в себе несколько форматов и подходят для большинства товаров. Выбор огромный, главное – решите, что подойдет в вашем случае.
Рекомендуемые статьи по данной теме:
- Примеры УТП, чтобы придумать свое еще круче
- Продающий прайс-лист: 5 маркетинговых фишек + 10 подсказок для оформления
- Как увеличить поток клиентов, правильно подобрав способ
5 критериев хорошей инструкции
Самый эффективный для автора формат руководств – статьи-инструкции. Он не только позволяет продемонстрировать читателям глубокие понимание темы, но и дает прекрасную возможность закрепиться в вашей нише на долгое время. Более того, качественно составленная инструкция присылается знакомым и остается с пользователем на многие годы, а это увеличивает трафик и количество подписчиков.
Как правильно написать инструкцию:
- Актуальность темы То, о чем пишете, должно быть представлено аудитории своевременно. Инструкция сработает только в том случае, если получит отклик читателей, а значит, выбранный вами контент должен соответствовать формату. При публикации постов на «Хабре», например, не стоит писать о темах, ориентированных на новичков. Даже если это то, что актуально, популярностью оно пользоваться не будет. Покопайтесь в больших объемах информации и найдите цепляющее содержание. Специализированные форумы, журналы и статьи вам в помощь.
- Применение в деле Если руководство невозможно использовать на практике – это плохая инструкция. Любой читатель захочет проверить, насколько эффективным окажется предлагаемое решение. Текст должен быть конкретен, последователен и прост. Давать общие советы и рекомендации может любой дилетант, но вы – профессионал. Пишите четко, определенно и по делу.
- Все необходимое Крайне важным моментом будет наличие в статье всего необходимого, чтобы не пришлось искать дополнительную важную информацию по другим сайтам. Если речь идет об оформлении документов – прикрепите их образцы или хотя бы ссылки на них. Если пишете о достоинствах того или иного товара, укажите, где его приобретали или дайте конкретную ссылку на продукцию. Все это облегчит поиск читателю, а вам добавит доверия.
Помните: чтобы написать грамотную пошаговую инструкцию, вы сами напрямую должны были с этим столкнуться и прийти к успешному результату. Экспертное мнение и профессиональный опыт станут лишь дополнительными бонусами. Просто посмотреть инструкцию в Интернете и переписать ее себе – недостаточно. Детали крайне важны.
6 этапов написания инструкции
Отвечая на вопрос, как написать инструкцию, можно выделить шесть основных этапов. Соблюдая их, получится составить полезный и нужный пользователям материал:
- Поиск проблемы. Любая инструкция несет в себе решение задачи путем совершения определенных действий. Важно, чтобы проблема соответствовала общей тематике сайта или вашего блога.
- Ориентирование в проблеме. Чтобы инструкция была хорошей, автор сам должен разбираться в вопросе. Это должен быть ваш опыт, а не взятый с просторов Интернета и непроверенный лично перечень действий.
- План решения. Первым пунктом в этом деле будет обозначение проблемы, последним – результат описанных действий, все остальное – промежуточные шаги, которые позволили из первого пункта прийти к последнему. Главное – этапы должны быть простыми, понятными и информативными.
- Подробность. Всегда можно что-то добавить на каждом этапе. Избегайте «воды», четко и объемно формулируйте идею каждого пункта.
- Визуал. Добавляйте в инструкцию инфографику, фото и изображения, которые упростят процесс понимания каждого этапа. Однако имейте в виду, что визуальное сопровождение может быть уместным не везде. Например, в статье «Как правильно написать инструкцию по применению лекарственного препарата», перегруженность фотографиями станет лишней.
- Советы и рекомендации. Люди доверяют больше опыту и жизненным советам, чем сухому тексту с алгоритмом действий. Используйте это там, где необходимо.
Применив эти правила, получится написать интересную и полезную инструкцию, которая не только сможет решить ряд некоторых вопросов читателей, но и разнообразит ваш контент.
Кейс: VT-metall
Узнай как мы снизили стоимость привлечения заявки в 13 раз для металлообрабатывающей компании в Москве
Структура инструкции
Любая статья требует плана, и инструкция – не исключение. Автору необходимо разбить тему на несколько пунктов и кратко описать каждый, добавить таблицы, цифры и факты, если таковые необходимы.
План выглядит следующим образом:
- Цель статьи Тут все достаточно просто. Надо определиться, о чем хотите рассказать подписчикам, какую проблему и как решить. Обозначив цель, вы будете придерживаться той тематики, которую планировали описать изначально, не перескакивая с одного вопроса на другой.
- Заголовок Не всегда это бывает просто. Как правило, название материала соответствует самим запросам пользователей, например: «В каком порядке смотреть фильмы Марвел», но если кроме релевантности заголовок еще будет цепляющим, это – гарантированный успех статьи. Очень эффективно срабатывают заголовки, начинающиеся с цифр, и лучше всего использовать не круглые числа типа 10, 20, а нечетные 12, 23, 7 и т. д.
- Введение, или лид Вы должны суметь в первом абзаце, а желательно – в первых 2–3 предложениях вовлечь читателя и удержать его. Он должен понимать, что именно эта инструкция – тот самый кладезь информации, который он искал долгое время.
- Основная часть В классической инструкции это будет несколько подробно описанных этапов. В статье, освещающей задачу, должны быть разные взгляды на поднятый вопрос. Инструкция-перевертыш – каждый пункт соответствует описанию проблемы, причинам ее возникновения и способу решения.
- Кульминация и выводы Резюмируйте все написанное вами, сделайте выводы и побудите своего читателя совершить действия. Если это сделать получилось, считайте, что цель статьи достигнута.
9 советов по написанию отличной инструкции
Чтобы ответить на главный вопрос сегодняшней статьи – как написать инструкцию – важно учитывать следующие особенности ситуации.
Оцените уровень знаний читателя
Прежде чем создавать подробный алгоритм действий, поймите, на кого он будет направлен. Например, вы решили написать о том, как вырастить помидоры в любой почве и в любых условиях.
Смотрим на целевую аудиторию:
- Это известный фермер, работающий в лаборатории Илона Маска и готовящийся к высадке данной культуры на Марсе?
- А может – огородник в возрасте, не готовый переплачивать за удобрения и тепличное оснащение?
- Ученик пятого класса, который делает практическую работу по биологии?
Любому из этих пользователей требуется своя подача материала, которая будет отличаться какими-то особенными моментами, примерами, изображениями, структурой, объемом профессиональных терминов, и др.
Пожилому огороднику не будут понятны научные термины, которые использует фермер-лаборант, а школьнику не нужны огромные объемы помидор, для практической работы ему вполне хватит 1–2.
Если вы не определитесь с тем, для кого вы пишете инструкцию, вы не только потратите зря время, но и понизите востребованность своего профиля. Помните, что новички и уверенные пользователи даже одну и ту же тему воспринимают по-разному.
Проверьте, есть ли уже подобные инструкции
В Интернете есть огромное количество информации по любой теме, потому необходимо узнать, есть ли уже в Сети подобный материал. Если есть: что бы вы могли взять из этой статьи на вооружение? Списывать и адаптировать каждый пункт под себя не надо, просто прочтите ее полностью и почерпните важные моменты, которые, возможно, упустили. Зафиксируйте их в заметках, подумайте, что бы можно к ним добавить еще или убрать.
Готовьте серию инструкций
Как написать пошаговую инструкцию по установке двери, если они могут быть входными, балконными и межкомнатными, различаться по монтажу? Действительно, все не так уж и просто. На самом деле, читателю лучше пригласить специалиста, но если он относится к тем, кто привык делать все самостоятельно, то вам лучше всего написать серию статей с подробным процессом установки каждого вида дверей.
Конечно, можете сделать и общий вариант, указав ряд различий в специализированных монтажах, но вряд ли новичок сможет хорошо ориентироваться в куче информации, представленной в таком виде. Краткое описание действий по каждому типу дверей придется по вкусу как продвинутым домохозяевам, так и новоиспеченным.
Проверяйте инструкции
Безусловно, знания в вопросе будут являются решающим фактором в написании инструкции, но важно не только ориентироваться в теме, но и уметь передавать эту информацию простым обывателям легким и доступным способом. Многие блогеры часто перегружают свои статьи специальными и узконаправленными терминами, пускаясь в бесконечный поток объяснений.
В итоге читатель уже перестает понимать представленную ему информацию. Даже если вы досконально изучили тему, как написать простой и понятный текст в инструкции, и вроде бы знаете все нюансы, обязательно прочтите свою статью еще раз, а в идеале обратитесь к трем людям с разным уровнем знаний в той или иной теме:
- Редактор. Это тот самый человек, который проверит вашу статью на наличие грамматических и лексических ошибок, избавит текст от ненужных выражений, канцеляризмов и прочих стилистических недочетов.
- Новичок. Тот, кто подскажет, насколько понятна и проста в исполнении ваша инструкция для человека, который столкнулся с проблемой впервые. При желании он может проверить написанные вами рекомендации на личном примере и поделиться результатом.
- Эксперт. Настоящий знаток дела сможет подсказать, насколько ваша статья достоверна и при необходимости дополнить ее фактами.
Такой доскональный анализ и редактура инструкции сделают ее читабельной, понятной, популярной и ценной. Будьте уверены, ею будут делиться с друзьями и репостить.
Не переписывайте чужие инструкции
Плагиат – это не выход из ситуации. Публикуя статью, вы можете спокойно ссылаться на других авторов, книги и инструкции, но не копируйте все наглым образом. Во-первых, у создателя его работы могут иметься авторские права, а во-вторых, никому не понравится, если его труды присвоит кто-то другой.
Отжимайте лишнюю «воду»
«Вода» – главный враг хорошего руководства. Она будет лишней в любом тексте, а в инструкции – тем более. Когда человек хочет решить проблему, наличие канцеляризмов и долгих объяснений только раздражает. Нужен краткий и информативный текст, чтение и осознание которого не займет много времени.
Неудачно написанная инструкция начинается примерно так:
У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.
Как правильно написать инструкцию в этом случае:
В данном гайде вы найдете 11 простых способов рисования круга в «Фотошопе». Руководство подойдет для версии СС 2015 и выше.
В этом вступлении нет никакой воды, понятно, о чем будет речь и сколько примеров. Чем короче руководство, тем оно привлекательнее, но не забывайте об информативности предложений.
Без картинок – никуда
Уже не первый раз мы говорим о важности визуального сопровождения. Сплошной текст очень раздражает глаз, его попросту лень читать, но если пункты дополняются соответствующей иллюстрацией, восприятие уже меняется.
Бывает так, что определенную кнопку или горячую клавишу трудно найти, и описание ее местонахождения займет целый абзац. Картинка сделает эту информацию более приемлемой. И автору проще, и читателю понятнее.
Редко, но бывает такое, что соответствующей фотографии нет, тогда вам на помощь приходит YouTube. Там-то есть все. Смо́трите видео, нажимаете на паузу и делаете скриншот. Если у вас есть больше свободного времени и желания, визуальное сопровождение вы можете нарисовать сами в графическом редакторе. Если наличие видео или фото может быть неудобно и неуместно, тогда ставьте анимацию.
Прекрасной альтернативой текстовой инструкции может стать видеоответ, где вы детально все описываете и показываете. Возможно, кто-то захочет читать и смотреть видео одновременно, но не включая звук. В таком случае добавьте субтитры.
В рецептах и тех инструкциях, где особенно важен результат, не забудьте прикрепить фотографию того, что получилось. Читателям важно знать, к чему они придут, если будут следовать вашим указаниям.
Выдерживайте статью в одном стиле
Единый стиль написания – еще один фактор, влияющий на успешность статьи. Информация должна быть представлена цельным полотном, не перегружена канцеляризмами, речевыми оборотами и сложными предложениями. Наличие фактов и изображений, отсылок на мнения известных людей станет хорошим инструментом воздействия на читателей.
Пример неверного написания:
Цвет в интерфейсе сразу обращает на себя внимание и несет определенную смысловую нагрузку, его следует использовать осторожно и со смыслом.
Образец, как надо написать инструкцию, чтобы она была читабельной:
Цвет — это инструмент управления вниманием пользователя: он помогает выделять главное. В интерфейсе краски используются для передачи смысла, а не для оформления.
Общие советы, которые вроде бы и говорят о важном, но в то же время не дают никакой конкретики, тоже не принесут результата.
Неправильно (т. к. нет никакого четкого пояснения):
В интерфейсах должна быть простая и понятная навигация.
Старайтесь избегать местоимения «мы», по возможности.
Запреты тоже могут быть нескольких типов. Используйте каждый там, где это необходимо:
- Самый мягкий вариант – «Не рекомендуется делать подобным образом».
- Средний вариант – «Так поступать нельзя».
- Категоричный и жесткий вариант – «Строго запрещено делать подобное».
Не забывайте «оживлять» инструкцию, объясняя, почему так делать не рекомендуется или, наоборот, делать сто́ит, приводите примеры, факты и делитесь опытом из вашей жизни.
Не забывайте о безопасности
Важным моментом в написании инструкции является безопасность. Инструкции, которые вы пишете, могут быть связаны с любой темой, и порой не самой безопасной, поэтому не забывайте ставить пояснение о мерах предосторожности, будь то консультация со специалистом или использование средств защиты.
Скачайте полезный документ по теме:
Чек-лист: Как добиваться своих целей в переговорах с клиентамиЧасто задаваемые вопросы про написание инструкций
- Каким категориям бизнеса рекомендуется использовать инструкции?
В принципе, любой бизнес-сфере не помешают статьи с инструкциями относительно того продукта/услуги, которую выпускает организация. Магазины могут писать о руководстве по использованию своего товара и его эксплуатации, различные финансовые организации могут представить гайд о том, как регистрироваться на каких-либо экономических площадках, туристические фирмы могут сделать материал о том, какую страну и как лучше выбрать для проведения новогодних праздников, и т. д.
Делясь информацией с широкой публикой, фирма повышает процент доверия себе и получает больше шансов заполучить потенциального клиента.
- Чем инструкция отличается от обзора?
В наше время при частом смешении жанров эта граница стирается. Однако, если говорить официальным языком: обзор – демонстрация продукта, инструкция – представление действия, благодаря которым можно выбрать среди множества товаров тот продукт, который будет соответствовать всем требованиям потребителя.
Заголовки статей типа: «Как выбрать автомобиль…» больше подойдут под жанр инструкции, так как будут содержать в себе подробный алгоритм действий, по которым можно выбрать то, что потенциальному покупателю нужно.
- Как узнать, для какой аудитории пишется инструкция?
Как написать правильную пошаговую инструкцию, которая понравится потребителю? Все просто – пообщайся с клиентом.
Решая проблему потенциальных покупателей, вы сможете понять, что именно им нужно и как это преподносить. Узнаете, насколько люди осведомлены, каким уровнем знаний по этой теме обладают. Ответив на ряд таких вопросов, вы уже сможете подобрать стиль написания статьи. Обратившись к менеджерам по продажам или к операторам горячей линии, узнаете, с какими трудностями обычно сталкиваются эти потребители.
- Какой объем инструкции считается оптимальным?
По большому счету, это зависит от автора и самой темы инструкции, но, как показывает практика, чем короче руководство, тем лучше. Есть возможность уместить объяснение в одно-два предложения? Прекрасно! Читатели оценят.
Что делать дальше после публикации инструкции в блоге
Как написать инструкцию, мы разобрали, но что же делать, когда текст готов, проверен редактором, логичен, информативен и даже уже поставлен в пост? Для развития контента и увеличения трафика необходимо соблюдать следующее:
Обновление контента важно не только вашим постоянным читателям, но и случайным пользователям. Однако это не значит, что предыдущие статьи должны быть забыты. Наоборот, они нуждаются в регулярных обновлениях и повторных публикациях. С точки зрения продвижения, в корректировке старых постов больше выгоды, так как их индексация занимает у поисковых роботов меньше времени.
Важным шагом после того, как удалось написать пошаговую инструкцию, будет электронная рассылка. Когда читатели изучили ваше руководство, переместите их на страничку с формой согласия на получение новостей. Таким образом пользователи будут уведомлены об обновлениях либо смогут получать информацию напрямую.
- Взаимодействие с читателями
Контактируйте с вашей аудиторией. Побуждайте потенциальных клиентов писать пояснения и делиться мнениями, ведь это повысит популярность странички и увеличит движение трафика. Комментарии – это прекрасный инструмент, способный оказать существенное влияние на продвижение вашего аккаунта. Кроме того, пользователи смогут там делиться и другими полезными инструкциями, лайфхаками и ссылками.
- Возможность оценки контента
Поставьте кнопки оценки вашего контента. Это могут быть лайки/дизлайки, эмодзи, добавление в избранное. По утверждениям психологов, возможность сообщать свое мнение и говорить о том, полезен ли контент, дает людям ощущение нужности, а это благоприятно воздействует на их душевное состояние.
- Возможность делиться инструкциями
Желание представить статью другим не только позволяет пользователям передавать полезную информацию, но и делает ваш блог популярным.
- Сотрудничество с другими авторами
Сторонние площадки, подходящие вашей тематике, могут стать прекрасным полем развития блога. Общайтесь с другими авторами, работайте по бартеру – таким образом, вы сможете помочь друг другу повысить трафик, улучшить контент и увеличить популярность среди подписчиков.
Анализ контента – важный фактор в успешном продвижении блога, в котором публикуются инструкции, лайфхаки и обзоры. Есть масса инструментов, способных в этом посодействовать, например, Яндекс.Метрика – раздел «Контент».
Там можете увидеть количество просмотров вашей инструкции, сколько времени на странице провели пользователи, сколько посетителей, прочитав один пост, перешли к другому, и т. д.
- Подгрузка видео из YouTube
Благодаря блогу вы можете развить Youtube-канал. Снимайте подробную инструкцию, публикуйте ее на Youtube, а затем делитесь ссылкой в своем аккаунте. Пользователи, переходя по ссылке, скорее всего, подпишутся и будут изучать это видео уже напрямую, тем самым увеличивая просмотры.
- Наличие подкастов или голосовой записи инструкций
Различные подкасты и голосовые записи могут стать удобной альтернативой изучения руководства, если ваш читатель, например, едет за рулем автомобиля или занимается в спортзале и у него нет возможности смотреть видео или читать.
Материалы, в которых описаны качественные и грамотные инструкции, определенно будет иметь успех, а при умелом оформлении, когда есть возможность оценки контента и поделиться публикацией, количество читателей станет расти. Если будете следовать всем рекомендациям из этой статьи, созданная инструкция не только позволит увеличить трафик, но и расширит вашу аудиторию.
