Правила для написания руководства - Instruktiruet.ru - инструкции по эксплуатации и многое другое

РАБОЧАЯ ИНСТРУКЦИЯ, РЕГЛАМЕНТ И ПРОЦЕСС: В ЧЕМ ОТЛИЧИЯ

Термин «рабочая инструкция» неотрывно связан с термином «рабочий регламент». Регламент — это документ, который регулирует бизнес-процесс.

Таким образом все три понятия — процесс, регламент и инструкция — являются взаимосвязанными. Эти термины используются в современном менеджменте по управлению процессами организации — Business Process Management (BPM).

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

► Что такое Бизнес-процесс?

Стандарт ISO 9001 (Системы менеджмента качества) определяет понятие Бизнес-процесса как «Набор связанных или взаимодействующих действий, которые преобразуют входы в выходы».

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

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

Бизнес-процессы моделируются на основе стандарта модели бизнес-процессов и нотации BPMN (Business Process Management Notation).

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

Блок-схема процесса в нотации BPMN

Не путайте регламент процессом.

► Что такое Регламент?

В стандарте ISO 9001 говорится, что Регламент — это «Определенный способ выполнения деятельности или процесса». Если у вас есть процесс, который должен происходить определенным образом, и вы указываете, как это происходит, значит вы разработали Регламент.

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

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

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

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

Рабочая инструкция, регламент и процесс

► Что такое Рабочая инструкция?

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

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

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

Например, «Инструкция предоставления скидки», «Инструкция расчета стоимости проекта», «Инструкция оформления командировки» и т. п.

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

КАК НАПИСАТЬ РАБОЧУЮ ИНСТРУКЦИЮ: 7 ПРАВИЛ

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

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

Интернет изобилует забавными примерами плохо написанных инструкций и других, имеющих забавное двойное значение. Ниже представляем 6 правил, по которым специалисты Active Sales Group разрабатывают рабочие инструкции на проектах по усилению систем управления:

► Правило № 1 — ЯСНОСТЬ

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

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

Используйте простые структуры предложений: существительное (подлежащее) — глагол (сказуемое) — определение (прилагательное) — существительное (дополнение) — существительное (обстоятельство места).

Пример: «Менеджер (подлежащее) использует (сказуемое) полученные (определение) данные (дополнение) для формирования запроса на расчет (дополнение)».

Важно: избегайте деепричастных и причастных оборотов! Всегда используйте вместо них слово «который/-ая».

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

► Правило № 2 — ДОСТУПНОСТЬ

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

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

► Правило № 3 — ДОСТОВЕРНОСТЬ

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

► Правило № 4 — СОГЛАСОВАННОСТЬ

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

► Правило № 5 — КРАТКОСТЬ И ЯСНОСТЬ

Рабочая инструкция — это всегда краткость и ясность. Пишите максимально кратко и четко.

Если вы не можете объяснить подчиненным в простой форме, значит, вы недостаточно хорошо это понимаете! Найдите время, чтобы понять это полностью. Это позволит избежать ошибок в дальнейшем.

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

► Правило № 6 — ВИЗУАЛЬНОСТЬ

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

► Правило № 7 — ЭКСПЕРТНОСТЬ

Рабочую инструкцию должен писать человек, у которого есть опыт в выполнении задачи. Не передавайте задачу по написанию рабочих инструкций человеку, который не на 100% знаком с работой.

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

КАК НАПИСАТЬ РАБОЧУЮ ИНСТРУКЦИЮ ЗА 12 ШАГОВ

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

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

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

Источник

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

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

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

3 основных вида инструкций

Есть несколько типов инструкций. Они предназначены для разных целей, но разрабатываются по схожим принципам. К примеру – уяснив, как написать инструкцию по работе системного администратора, вы легко сможете применить эти знания и при подготовке руководства по использованию мини-АТС.

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

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

Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:

Откройте верхнюю крышку и извлеките блок фотобарабана
Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
Вытащите тонер-картридж
Поставьте на его место новый
Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
Установите фотобарабан обратно в принтер
Закройте крышку
Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 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. Нажмите на изображение, чтобы перейти на страницу с руководством.

Вывод

Резюмируя все изложенное, можно составить требования к идеальной инструкции:

Актуальность. В тексте нет устаревших сведений
Информативность и целостность. Подготовленное руководство содержит все необходимые сведения
по обозначенной теме. У пользователя не остается вопросов
Лаконичность. Приоритеты для составителя – это точность формулировок и отсутствие второстепенных сведений. Часто бывает, что инструкцию смотрят в сложных ситуациях, когда нужно быстро получить ответ на возникший вопрос
Наглядность. Информация сопровождается примерами и иллюстрациями
Конкретный результат. Руководство помогает получить конечное решение
Соотносимость с текущими знаниями пользователя. Чем ниже уровень знаний аудитории, тем подробнее объяснения
В тексте нет сложных конструкций. Они разбиты на несколько частей. Каждый пункт списка – это отдельное действие, которое дополняется комментариями и пояснениями

Вам будет интересно

Готовые курсы для бизнеса: проверенные агрегаторы онлайн курсов

Как учиться эффективно: проверенная технология обучения

Где провести вебинар: лучшие программы для вебинаров

Перейти на главную блога

Источник

Туториал для туториалов. Как написать пользовательскую документацию

Время на прочтение
12 мин

Количество просмотров 14K

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

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

Пользователи бывают разные. То есть они могут отличаться как по возрасту, отрасли и опыту, так и по количеству мотивации. Мотивация особенно касается b2b сервисов. Многие пользователи попадают в продукты, потому что «Начальник сказал».
Продукты бывают сложные. Быстро разобраться и понять все их фишки без документации сложно или невозможно.

Документация помогает пользователю решить проблему или помочь разобраться с особенностями и фишками продукта. В любой документации люблю раздел Tips&Tricks.

Что входит в пользовательскую документацию

Пользовательская документация — это не юридические документы. У них другие цели.

Пользовательская документация — это материалы, которые помогают пользователю использовать продукт на максималках.

Что еще можно отнести к пользовательской документации

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

В пользовательскую документацию я включаю:

Ответы на часто задаваемые вопросы (FAQ).
Руководство пользователя. Это самый жирный кусок из всей пользовательской документации. Здесь описывается весь интерфейс, только текстом.
Краткое руководство пользователя. Короткая презентация или документ для быстрого начала. Описывает базовые функции, возможности и советы для начала. Главное отличие от полного руководства — быстрее читаются, дают базовое представление о продукте и особенно помогают при внедрении b2b продуктов.
Описание отдельных фишек (Tips&Tricks). Чаще всего их делают в формате видеоуроков, но можно наткнуться и на текстовые.
Релизноуты. Считаю их важной частью пользовательской документации. И, говоря релизноуты, я имею ввиду не разовые, которые выкладываются в магазины приложений или к себе на сайт. А написанные раз в какой-то период. Можно раз в месяц. При работе над прошлым продуктом мы писали всё, что исправили или добавили за месяц. Хорошим тоном, на мой взгляд, будет писать самое важное.
Видеоуроки. Считаю их частью пользовательской документации, но это скорее вкусовщина, чем правило.

Почему это важно?

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

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

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

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

Красоты B2B рынка

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

Особенность #1: Корпорации любят печатную документацию. Очень сильно.
Мой знакомый сейлз любит рассказывать истории про это.

Резюме его историй:

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

Поэтому чем толще кипа бумаги — тем лучше.

Особенность #2: Нужно отдавать дополнительные пакеты документов.
В дополнительные пакеты документов входит: документация по установке вашего ПО и документацию по его администрированию, а может ещё что-то, если попросят.

Особенность #3: Документацию, которую вы отдаете корпоративному заказчику, нужно будет поддерживать отдельно.
Реальность работы с большими корпоративными заказчиками в том, что ваш продукт требует доработки для решения их задач. Всегда есть какие-то нюансы и дополнения. Поэтому отдавать им облачную документацию, чаще всего, не получится.

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

Где делать?

Много думал, долго смотрел. Переделывал наш гайд раз пять.

Когда искал, ставил для себя следующие задачи:

Документацию можно сделать динамической. То есть возможность грузить видео, гифки, делать кросс-ссылки.
Поддерживается базовое форматирование: заголовки, жирный, курсив, code, code block.
Возможность экспортировать в .pdf.

Небольшой совет

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

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

Какие вариант рассматривал:

Самописные.
Стоимость: может быть любой и измеряться в человеко-часах.
Плюсы: можно накрутить и наворотить, что по кайфу.
Минусы: долго, дорого, больно, потому что полноценный отдельный продукт, но для компаний больше 100 человек, может быть хорошим решением.
Google Docs.
Стоимость: Free
Плюсы: очень удобно работать с вёрсткой документа; привычный, при этом более простой интерфейс, относительно MS Docs; есть синхронизация с облаком; есть экспорт в .pdf.
Минусы: очень тяжело работать с визуальной частью — скринами; отношу в категорию не динамичных, так как выложить ссылочку на сайт на Google Doc конечно можно, особенно учитывая их последние апдейты, но это выглядит как-то не серьезно.
Notion.
Стоимость: можно Free, если работает один человек, а так от 8-10$ за человека.
Плюсы: очень удобно делать динамическую документацию, которую не стыдно выложить на сайт, по моим ощущениям; удобно работать в паре, есть все необходимое; можно вставить любое медиа, хоть ссылку, хоть видео, хоть схему из miro.
Минусы: не самый широкий спектр инструментов для работы с версткой; если неправильно сверстать, скопировать кусочек текста в другое место бывает накладно; не для всех пользователей привычная навигация по страницам.
Другие инструменты для wiki. Я смотрел на несколько вариантов wiki.js, Stonly 2, Dropbox Paper, Outline.

Смотрел давно, поэтому ничего вразумительно сказать не смогу. Помню, только что из всего выше, зацепил Dropbox и Wiki.js. В процессе написания этой статьи наткнулся ещё на один интересный сервис — GitBook. Он удовлетворяет всем моим запросам к подобным инструментам, но прошел мимо меня когда выбирал.
Figma.
Не пробовал, но хочу попробовать для ускорения работы именно с корпоративной документацией, есть у меня одна идея, как будет время попробую и расскажу.

С чего начать?

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

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

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

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

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

Основные правила

Понятный и простой язык

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

Любой текст должен быть простым и понятным.

Самое главное всегда это помнить.

Из рекомендаций, которые могу дать я лично — отказываться от привычных определений и писать ещё проще.
Например, вместо «Кликнуть» писать «Нажмите», вместо «Свайпнуть» — «Провести». Так нужно делать, потому что среди пользователей могут быть люди, которые не знают даже базовых терминов.

Понятное и аккуратное форматирование

Я люблю типографику и когда все аккуратно. Поэтому случаются приступы гнева, когда документы плохо сверстаны. Считаю это важным, так как эти правила придумали не просто так, а чтобы было удобно для читателя.

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

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

Основные кавычки оформляются елочкой «», внутренние кавычки оформляются лапками „“. Например, «Нажмите на вкладку „Контакты“ в левом верхнем углу», забугорные кавычки выглядят так «_».

Рекомендации по оформлению текста от Риановости
P.S. Иностранные названия в русском тексте кавычками не выделяются.
Тире и дефис.
Все знают про тире и дефис. Оказалось, что многие не знают про среднее тире.

Дефис (-) используется для присоединения частиц (что-то), для присоединения префиксов (по-братски), в словосочетаниях и сложносоставных словах (бизнес-ланч).
Среднее тире (–) применяется в числовом обозначении диапазонов и интервалов: 2011–2022, 11–12 ноября.
Длинное тире (—) используется для выделения прямой речи, указания маршрутов (Москва — Санкт-Петербург), между подлежащим и сказуемым.

Рекомендации по оформлению текста от Риановости

Оформление списков.
Существуют два вида списков: нумерованный и маркированный.

Маркированные списки выделятся буллитами, длинным тире или выключкой (реже всего встречается, сдвиг вправо, без символа), нумерованные списки выделяются числами.

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

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

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

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

Если есть числа, то их нужно тоже оформить правильно. Не 2221, а 2 221. Отделяйте тысячные, это очень сильно упрощает восприятие.
Вы или вы.
Мое стойкое мнение — если это не коммуникация с кем-то из государственной организации в переписке, всегда писать вы и ваш с маленькой буквы. Иначе выглядит, что вы кричите на пользователя, а на пользователя нельзя кричать.

В случае с гос. организациями все очень просто, я считаю, что если они узнают, что можно писать с маленькой, их мир рухнет.
Буква Ё.
С этой буквой у меня особые отношения. Исторически моя фамилия пишется через Ё, но из-за передергивания правил русского языка в советском союзе моя фамилия теперь пишется через Е. Поэтому я долгое время принципиально везде писал Е. Годы идут. Мозгов прибавилось. Теперь стараюсь писать Ё везде, где ей место. Так действительно проще воспринимать текст.
Эмодзи в тексте 🦄
По этому поводу много споров как у нас в команде, так и в кругах пишущих. Я придерживаюсь мнения, что эмодзи в тексте допустимы, но очень дозировано.

Я использовал эмодзи для визуального подчеркивания каких-то кнопок в интерфейсе.
Например: Нажмите на символ ⚙️ в правом верхнем углу.

Для поиска символов пользуюсь Glyphy.

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

Если ваш продукт международный

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

Удобная навигация

Нет единого мнения — как правильно. Если самопис, я рекомендую делать вертикальную навигацию слева. Такая часто встречается в технических документациях.

По структуре, на мой взгляд, можно выделить такие блоки:

Блок общего и важного.
- Описание вашего решения. Вдруг пользователь попал сначала на ваш гайд, а не на сайт.
- FAQ.
- Какие есть приложения, со ссылками на скачивания или как пользоваться, если это например веб-версия.
- Наши обновления.
Блок «Как начать». Сюда писать общие вещи, которые касаются всего сервиса. Особенно важный блок, если у вас мультиплатформенное решение.
Блок с руководством пользователя. Если у вас мультиплатформенное решение, то на каждую платформу лучше писать свое руководство. Можно объединять мобильные приложения и ПК версию. Так можно делать если нет глобальной разницы.

У нас, например, исторически разницы не было. Поэтому iOS и Android лежат на странице «Мобильные приложения». Но сейчас мы начали разделять, поэтому в будущем будет разделение на ОС.

Связность

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

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

Удобный поиск

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

Вот как мы это в Notion решили.

Логичность

Всё, что вы пишите должно быть логичным.

Порядок элементов в тексте и интерфейсе должен быть одинаковым. Пользователь ломается, когда написано: «Нажмите на вторую вкладку „Контакты“», а вторая вкладка — «Чаты».
Или когда в интерфейсе элемент называется «Назначить админом», а написано «Назначить администратором».

Понятная визуалка

Этот пункт я бы хотел разбить на два блока: работа с медиа и работа с Step-by-Step.

Работа с медиа

Я сторонник динамичных гайдов. Когда есть .gif или видео презентация. Это помогает увидеть наглядно. Если есть возможность, наполняйте вашу документацию .gif.
С видео все сложнее. Оно требует дополнительного действия от пользователя — включить, плюс весит больше чем .gif. Поэтому видео использую редко. Чаще для каких-то больших блоков или полноценных видеоуроков.

Иногда нет возможности сделать документацию динамической, особенно если вы работаете с корпоративными клиентами. Тогда делайте скриншоты реального интерфейса. Для этого лучше завести демо-стенд с близким к реальности наполнением. И там делать скриншоты.
Можно нарисовать демо-стенд в Figma и из этого собирать медиа для гайда. У меня такой подход не прижился, сложнеё управляться.

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

Очень не люблю стрелочки. Считаю, что лучше выделить место геометрической фигурой и поставить номер шага. Но иногда стрелочки приемлемы, тут вкусовщина.

Из хороших приемов — блюрить лишнюю часть интерфейса или делать выделение лупой важной части.

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

Step-by-step

Step-by-Step — это пошаговое описание всех действий, которые нужно выполнить пользователю, чтобы получить результат.

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

Делать нумерованные списки. Если есть подпункты, то нумеровать их соответственно и делать сдвиг вправо 1.1, 1.2, 1.2.1 и тд.
Писать сначала «Что нажать», потом «Где нажать». Исхожу из простой логики — сначала нужно понять «Что искать» и только потом «Где искать».

Например: «Нажмите на кнопку „Включить“ в правом верхнем углу», а не «В правом верхнем углу нажмите на кнопку „Включить“».
Вставлять визуальные элементы для кнопок, особенно если они без подписи. Для этой истории приходится немного костылить, если делать это в том же Notion, но в Google Docs это делать проще. Использую стандартные эмодзи и сервис Glyphy.

Например: Нажмите на символ ⚙️ в правом верхнем углу.

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

Поддержка и послесловие

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

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

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

Раз в 3-6 месяцев заходить и перечитывать, лучше если это каждый раз будет делать новый человек. Это нужно делать по трем причинам:

1. Когда пишешь большие текстовые документы, глаз замыливается. Можно написать бред и после его не заметить.

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

3. Всегда есть что улучшить. Текст это такой же продукт.

Хочется верить, что эта статья сэкономит кому-то время, а кому-то поможет стать немного лучше.
Я не претендую на истину в последней инстанции. Описал свой опыт и мнение.

p.s. Пользовательская документация с которой все началось. Скажу сразу, там очень много чего можно и нужно улучшить. Бэклог по апдейту документации уже перевалил за 30 задач. Постепенно обновляем.

p.s.s. буду благодарен за конструктивный фидбек в комментариях и ещё больше, если поделитесь вашим опытом.

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

Приятного чтения.

Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины:

1. Качественная документация повышает лояльность клиента и ценность продукта в целом.

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

2. Руководство пользователя экономит время и силы техподдержки.

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

А теперь к советам!

Общие советы по созданию руководства пользователя

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

— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)

— Насколько объективно сложен для понимания продукт и как часто пользователь будет обращаться к документации?

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

(Для изложения лучше всего выбрать нейтрально-формальный стиль)

Структура руководства пользователя

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

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

В первом разделе расскажите общую информацию о продукте. Для чего создан проект и какие задачи он решает.

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

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

В любом руководстве желательны разделы «Частые вопросы» и «Устранение типовых проблем». Расскажите о проблемах, с которыми часто сталкиваются клиенты и о путях их решения.

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

И последний «обязательный» раздел, которой точно должен быть в любой документации – «контактная информация». Данный раздел даст пользователю возможность связаться с разработчиком. Если руководство вдруг не закрывает потребность читателя, то он может обратиться в поддержку. Кроме того, клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.

Профессиональный совет: если вы хотите максимально облегчить ношу клиента при чтении документации создайте контекстно-зависимую справку. Что это такое?

Представьте, что вы работаете в программе для создания пользовательской документации. Открываете меню основных настроек и видите раздел «аннотирование экрана» Заходите в него, там показаны разные стили аннотации, тени, фон и так далее. Но что такое аннотация? Допустим вы не знаете — нажимаете кнопку F1 и перед вами открывается руководство именно на той странице, где рассказано об «аннотировании экрана»

Как ее сделать? Смотрите ниже.

Контент

И так, мы создали «каркас» нашей документации, но чтобы руководство стало полезным нужно наполнить её компетентной информацией.

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

1. Понятность.

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

2. Наглядность.

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

3. Видео.

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

Но как добавить в документацию видео? Смотрите ниже.

Больше советов!

Когда документация будет готова, чтобы она стала «полноценной» её нужно опубликовать. Иначе какой от неё толк, если клиент не может её прочитать. У «юзера» всегда должен быть доступ к документации, и не важно где он. Такую потребность легко закрывают три формата: HTML, PDF и CHM.

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

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

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

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

Инструменты

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

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

Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.

Благодаря «доктору» вы сможете опубликовать и обновлять документацию в востребованных форматах (CHM; HTML; PDF; DOC), не выходя из программы.

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

Импортируйте в программу заранее написанные фрагменты документации.

Вы сможете создать контекстно-зависимую документацию, настроить визуальный стиль руководства, добавить в него видео и многое другое!

Какой можно сделать вывод

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

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

Работая с Dr.Explain, можно быстро написать пользовательскую документацию, которая будет помогать клиентам разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.

Спасибо за внимание!

Со всеми возможностями Dr.Explain можно ознакомиться здесь:

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

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

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

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

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

Структура руководства пользователя

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

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

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

Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.

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

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

Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: 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 — инструмент для создания мобильной версии пользовательской документации к программным продуктам
Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

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

Разделы руководства пользователя:

Введение.
Назначение и условия применения.
Подготовка к работе.
Описание операций.
Аварийные ситуации.
Рекомендации по освоению.

1. Введение

В разделе «Введение» указывают:

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

1.1. Область применения

Требования настоящего документа применяются при:

предварительных комплексных испытаниях;
опытной эксплуатации;
приемочных испытаниях;
промышленной эксплуатации.

1.2. Краткое описание возможностей

Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:

формирование табличных и кросс-табличных отчетов;
построение различных диаграмм;
экспорт и импорт результатов анализа;
печать результатов анализа;
распространение результатов анализа.

1.3. Уровень подготовки пользователя

Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:

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

Квалификация пользователя должна позволять:

формировать отчеты в Oracle Discoverer Plus;
осуществлять анализ данных.

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

Информационно-аналитическая система «Корпоративное хранилище данных». ПАСПОРТ;
Информационно-аналитическая система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

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

Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.

Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.

Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.

3. Подготовка к работе

В разделе «Подготовка к работе» указывают:

состав и содержание дистрибутивного носителя данных;
порядок загрузки данных и программ;
порядок проверки работоспособности.

3.1. Состав и содержание дистрибутивного носителя данных

Для работы с ИАС КХД необходимо следующее программное обеспечение:

Internet Explorer (входит в состав операционной системы Windows);
Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.

3.2. Порядок загрузки данных и программ

Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:

Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
Во время загрузки в появившемся окне «Предупреждение о безопасности», которое будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator» …’ Нажимаем на кнопку «Да».
После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.

3.3. Порядок проверки работоспособности

Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:

Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
Убедиться, что в окне открылось приложение Oracle Discoverer Plus.

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

4. Описание операций

В разделе «Описание операций» указывают:

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

Для каждой операции обработки данных указывают:

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

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

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

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

Ниже приведено описание пользовательских операций для выполнения каждой из задач.

Задача: «Визуализация отчетности»

Операция 1: Регистрация на портале ИАС КХД

Условия, при соблюдении которых возможно выполнение операции:

Компьютер пользователя подключен к корпоративной сети.
Портал ИАС КХД доступен.
ИАС КХД функционирует в штатном режиме.

Подготовительные действия:

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

Основные действия в требуемой последовательности:

На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».

Заключительные действия:

Не требуются.

Ресурсы, расходуемые на операцию:

15-30 секунд.

Операция 2: Выбор отчета

Условия, при соблюдении которых возможно выполнение операции:

Успешная регистрация на Портале ИАС КХД.

Подготовительные действия:

Не требуются.

Основные действия в требуемой последовательности:

1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».

2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:

Заключительные действия:

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

Ресурсы, расходуемые на операцию:

15 секунд.

Задача: «Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

Класс ошибки	Ошибка	Описание ошибки	Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД	Сервер не найден. Невозможно отобразить страницу	Возможны проблемы с сетью или с доступом к порталу ИАС КХД.	Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя	При регистрации на портале ИАС КХД не введено имя пользователя.	Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации	При регистрации на портале ИАС КХД не введен пароль.	Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку	Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована.	Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции	Нет электропитания рабочей станции или произошел сбой в электропитании.	Рабочая станция выключилась или перезагрузилась.	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети	Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД	Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

Рекомендуемая литература:

Oracle® Business Intelligence Discoverer Viewer User’s Guide
Oracle® Business Intelligence Discoverer Plus User’s Guide

Рекомендуемые курсы обучения:

Discoverer 10g: Создание запросов и отчетов

В качестве контрольного примера рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в п. 4.2. настоящего документа.

Существует множество видов предоставления справочной информации пользователю – это и 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 Create Project overlay fill in all mandatory fields.
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. Поддержка

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

Заключение

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

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

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

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

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

Источник

Как написать статью-инструкцию или пошаговое руководство

Содержание

Гайды, инструкции и пошаговые руководства — как собрать стеллаж, как выбрать гель для мытья посуды, как стать маркетологом — всегда актуальный и полезный контент. Они используются повсеместно, подходят для разных тем, площадок и ЦА.

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

Где использовать статьи-инструкции

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

Пошаговые руководства публикуются:

на информационных сайтах;
в блогах и на коммерческих площадках;
на форумах и в социальных сетях.

Правила написания

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

Правильно выбирайте ЦА. Ответьте на вопрос: кто будет читать пошаговое руководство? Гайд для новичков — это одно. Инструкция для тех, кто уже разбирается в теме и хочет прокачать скилы, — совсем другое.

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

Досконально разбирайтесь в вопросе. Гайды пишут эксперты или копирайтеры.

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

При выборе темы убедитесь, что она соответствует тематике вашего блога или сайта, а главное — актуальна и интересна ЦА. Запомните формулу: один гайд — один вопрос. Распыляться не стоит, иначе статья получится громоздкой и ее будет неинтересно читать.

Составляйте план будущего руководства. Основа любой инструкции — хорошо продуманные тезисы.

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

Универсального плана для написания руководств не существует. Иногда в начало гайда необходимо добавить раздел с расшифровкой терминов, иногда — уделить 1–2 абзаца предыстории. Чтобы инструкция использовалась на практике, логика действий должна быть четкой и понятной.

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

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

Убирайте из инструкции канцеляризмы, штампы и стоп-слова — читатели не дочитывают такие статьи до конца. Проверяйте тексты на «воду» в таких сервисах, как «Адвего», Istio.com и Text.ru. Норма — 55–75%, но она может варьироваться в зависимости от тематики.

Добавляйте картинки и примеры. Гайд без визуального сопровождения — это не гайд.

Добавляйте в текст скриншоты или фотографии, GIF-анимацию и инфографику с диаграммами, блоками и схемами. Они сокращают объем руководства, структурируют информацию, делают ее нагляднее.

Берите на заметку бесплатные сервисы для создания инфографики: Сanva, Easel.ly, Piktochart, Venngage. И еще несколько ресурсов для создания GIF-анимации: Gifovina, Gifs (создает анимацию из видео на YouTube) и Online-convert.

Алгоритм написания

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

Шаг 1. Подготовка и сбор информации

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

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

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

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

Технология
речевой аналитики
Calltouch Predict

Автотегирование звонков
Текстовая расшифровка записей разговоров

Узнать подробнее

Шаг 2. Структурирование

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

Введение должно состоять из 2–4 предложений. Используйте его, чтобы быстро ввести читателя в контекст и вызвать у него доверие и интерес. Если тема позволяет, поделитесь любопытным фактом или статистикой, если нет — коротко опишите проблему и переходите к ее решению.

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

Заключение — итоги статьи. Сделайте эту часть полезной для читателя. Составьте памятку с краткими выводами, по которым удобно делать то, о чем было подробно рассказано в основной части вашего руководства. Для этого перечислите 5–7 основных тезисов или сделайте выжимку рекомендаций по типу той, которая будет в конце этой статьи.

Заголовок (H1) должен быть коротким, но емким. Вот несколько примеров, которые можно взять на заметку:

«Краткая/полная/пошаговая инструкция…»;
«Создайте…с нуля»;
«Простой/уникальный способ…»;
«Как сделать/приготовить/создать…»;
«Быстрое решение…»;
«8 шагов для…»;
«Метод…»;
«Секрет правильного…».

Внутренние подзаголовки (H2, H3…) разделяют информацию на блоки или являются этапами пошаговой инструкции — это зависит от объема текста.

Шаг 3. Написание текста

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

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

Шаг 4. Завершение

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

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

Сквозная аналитика Calltouch

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

Узнать подробнее

Вместо вывода

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

Источник

Загрузить PDF

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

1

И в этом вся соль. Да, звучит очевидно, но знание — ключ к успешному написанию руководства. Вы должны знать предмет если не во всех-всех, то хотя бы во многих тонкостях. Чем лучше и глубже вы знаете предмет, тем проще вам будет объяснить незнакомому с ним человеку что угодно.
2

Проконсультируйтесь с экспертами. Если ваша задача — просто написать, а не выступить в качестве эксперта, то и писать придется “под диктовку”, сверяясь с экспертами и давая им проверить написанное. Знание и советы от знающих людей бесценны.
3

Используйте практический подход. Попробуйте и сами сделать то, о чем пишете, и вы поймете, о чем захочется узнать вашему читателю и что выяснить.
4
Почитайте больше тематических источников. Прочтите то, что уже написано по теме вашего руководства — это будет только на пользу.
- Аналогичные руководства помогут понять, о чем и как надо писать.
  - Анализируйте прочитанное, ищите общие черты к описанию особенностей и функционала.
  - По аналогии поступайте с различиями. Так вы сумеете описать уникальные функции своего товара или продукта. Чем больше информации в руководстве, тем лучше и тем больше вероятность, что читатель будет заинтересован ею и дочитает ее до конца.
- Читайте тематические журналы. Узнайте, как пользуются тем или иным инструментом люди, которым он необходим в повседневной практике. Может, исходя из этого следует уделить больше внимания какой-нибудь особенности вашего продукта.
Реклама

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

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

Возьмите этот шаблон за основу содержания руководства.
4

Прочитайте все и проверьте. Убедитесь, что ничто не отходит от выбранной вами схемы повествования.
5

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

Реклама

1

Напишите введение. Это задаст тон всему руководству и покажет читателю, что его ждет. А то, каким должно быть вступление, зависит от вашего читателя. Понятно, что инструкция о том, как сделать открытку к дню рождения будет слегка отличаться от “инструкции” по проведению операции на открытом сердце. Выберите стиль повествования и не отходите от него.
2
Выполните все действия, параллельно записывая все. Так не только будет честно, но еще и вы сами ничего не пропустите.
- Если такой возможности нет, то обязательно проконсультируйтесь в конце с экспертом.
3
Пронумеруйте действия. С нумерованным списком людям работать проще, это факт.
- Если вы пишете на бумаге, оставляйте между строчками достаточно места, чтобы выставить еще линию-другую. И не забудьте сдвинуть нумерацию, если что.
4
Напишите советы и предупреждения. В процессе работы над руководством вас может посетить мысль о том, что без должной тщательности выполнение того или иного действия пользователем может привести к проблеме.
- Плюс если у вас есть в памяти интересный факт, которым будет полезно поделиться с читателем — напишите и его.
5
Проверьте все. Итак, у вас есть инструкция — теперь сделайте нужное действие строго по вашему руководству. Если вы найдете места, где ваше руководство непонятно, неадекватно, неточно и т.д. — исправьте все как надо. Повторяйте этот этап до тех пор, пока ваше руководство не станет полным.
- Полезно будет дать почитать руководству другу и посмотреть, поможет ли оно им. Следите за их реакцией и затем внесите в руководство нужные изменения.
6

Отредактируйте руководство. Проверьте грамматику, орфографию, пунктуацию. Вы же не хотите сдать работу с ошибками?

Реклама

1
Начните с верхнего уровня. А верхний уровень — это заголовки. Закончив все выше перечисленные пункты, перечитайте руководство и найдите в нем будущие заголовки будущих разделов.
- Дайте им название и запомните, на какой они строке находятся.
2

Если нужно, сделайте содержание. Сгодится обычное иерархическое содержание, то есть главная страница и несколько подзаголовков с субкатегориями и так далее. Чем более проработанное и подробное руководство вы написали, тем больше разделов и подразделов вам понадобится.
3
Отредактируйте все еще раз. Да, именно. Еще раз. Во второй раз вы, вне всякого сомнения, увидите те ошибки, которые пропустили в первый раз.
- В случае более подробного руководства это также даст вам возможность выделить небольшие темы и внести их в содержание.
Реклама

Советы

По возможности, иллюстрируйте свое руководство. Если изображения вставлять нельзя, делайте отсылки к распространенным примерам.
Если есть возможность, дайте новичку попользоваться устройством, а потом запишите все заданные им вопросы. Это поможет сделать руководство полезнее и полнее.
Даже если что-то кажется вам очевидным, об этом все равно надо писать. Лучше написать больше, чем меньше.
Если вы пишите очень подробное руководство, где нужно написать целые главы — то начните с оглавления. И помните, что к главам применимы те же самые базовые требования, ибо что такое глава, как не мини-руководство?
Каждый раздел пишите на отдельной странице, так будет проще их, если что, поменять местами, внести исправления и так далее. На компьютере это особенно просто.

Об этой статье

Эту страницу просматривали 9088 раз.

Была ли эта статья полезной?

Источник

Как написать инструкцию так, чтобы тебя поняли

Время на прочтение
2 мин

Количество просмотров 44K

Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».

Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.

Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.

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

Итак, а теперь непосредственно к главному.

Выражение: «И так сойдет» — точно не для инструкций.

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

2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.

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

Примеры скриншотов с вполне понятными шагами:

4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.

5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.

6. Для сокращения объема текста возможно применение графических элементов. Например,

Local area connection ——> properties—>TCP/IPv4—>properties.

7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.

8. Не используйте в инструкции ничего из вашего личного опыта применения того или иного продукта или использования программы. Для этого существуют отдельные встречи с сотрудниками, где вы передаете им свой ценный опыт. А инструкция — это логичная структура, где описан «шаг — действие» и ничего более.

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

Эффективная юзабельная инструкция — это не простая формальность, это один из шагов к успешности и автоматизации рабочего процесса. Зеркальный юзабилити эффект заключается в том, что вещи, которые имеют отношение к собственного опыту, мы запоминаем лучше, чем те, которые не имеют к нам никакого отношения. Поэтому написание инструкций и памяток прокачивает менеджерские навыки специалистов. А это, в свою очередь, идет в «копилку скилов».

Источник

На чтение 10 мин Просмотров 1.1к. Опубликовано 30.10.2021

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

Зачем писать практические руководства?

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

Например, посчитайте, сколько людей каждый день ищут в Google «Как [любое слово]»:

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

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

Достаточно сказать: практические руководства стоит добавить в ваш арсенал контента.

Как сделать практическое руководство

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

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

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

Проведите исследование ключевых слов, чтобы узнать, что люди хотят узнать.
Используйте Ahrefs, SEMrush или любой другой инструмент SEO для определения похожих ключевых слов и запросов. Это может помочь вам создать всестороннюю статью, которая ответит на все вопросы ваших читателей и поможет вам получить рейтинг в Google.
Посмотрите на своих конкурентов, чтобы увидеть, как они пишут свои руководства.

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

Понять проблемы и проблемы вашей целевой аудитории.

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

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

Начните с ответов на вопрос «Что такое контент-маркетинг?» На Яндекс.Кью, например. Эти пользовательские ответы могут помочь вам определить общие темы, заблуждения или путаницу в контент-маркетинге.
Обратитесь к своей исследовательской маркетинговой группе, чтобы определить общие болевые точки или вопросы, которые они видели в опросах или фокус-группах относительно «контент-маркетинга». Например, вы можете обнаружить, что большая часть вашей аудитории считает контент-маркетинг для них приоритетом, но они не знают, как это сделать в рамках бюджета.
Проведение подобного качественного исследования предоставит вам информацию, необходимую для того, чтобы в вашем практическом руководстве были рассмотрены все актуальные проблемы по данной теме.

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

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

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

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

Расскажите читателю, почему это важно.

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

Как написать практическое руководство

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

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

Существует огромная разница между читателями, которые ищут «Что такое запрос предложения?», И теми, кто ищет «Как написать запрос предложения?».

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

При написании практического руководства следует помнить о некоторых методах:

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

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

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

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

Есть ли разница в том, как вы пишете руководство пользователя и практическое руководство?

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

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

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

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

Примеры практического руководства

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

Вывод: когда вы структурируете свое собственное руководство, подумайте, как вы можете его лучше организовать, чтобы читатели могли сразу перейти к тому, что им нужно. Кроме того, учитывайте среду, которую предпочтет ваша целевая аудитория.
Практическое руководство для B2B.В статье Atlassian «Как написать идеальный 90-дневный план» приведены важные контекстные детали для 90-дневного плана, в том числе «Что такое 90-дневный план?» и «Что должно быть включено в 90-дневный план?» Публикация хорошо проработана и написана с сочувствием.Лучше всего то, что в руководстве есть загружаемый PDF-файл с 90-дневным планом, так что читатели могут сразу загрузить и использовать план Atlassian со своей командой.

Вывод: подумайте, какие электронные книги, PDF-файлы, диаграммы, дизайны Canva или Google Таблицы вы можете создать самостоятельно и предложить читателям для загрузки. Читатели оценят возможность немедленно применить то, что они узнали.
Практическое руководство для B2C.Руководство «Как стать фрилансером» от FlexJobs отлично справляется с предоставлением соответствующих ссылок и данных для создания всестороннего обзора того, что такое фриланс. Кроме того, в сообщении используются глаголы действия, чтобы вдохновить читателя.В разделе «Как начать внештатный бизнес». вы увидите такие советы, как «Делайте домашнее задание», «Создайте бренд» и «Планируйте заранее». Язык, использованный в этом посте, во многом побуждает читателей немедленно приступить к работе.

Вывод: используйте глаголы действия и лаконичный язык, чтобы заинтересовать читателя. Когда возможно, начинайте с глагола вместо существительного при перечислении шагов.
Практическое руководство по продукту.Статья How-To Geek под названием «Как найти данные в Google Таблицах с помощью ВПР» не обязательно является самой интересной темой. Тем не менее, бренд эффективно поддерживает интерес к контенту с помощью чутких заявлений вроде: «ВПР может показаться запутанным, но это довольно просто, если вы поймете, как это работает».Кроме того, How-To Geek включает полезные оригинальные изображения, демонстрирующие каждый совет, который они описывают. Эти изображения не обязательно должны быть ультрасовременными визуальными эффектами, созданными профессиональной командой дизайнеров — как показывает этот пост, несколько простых снимков экрана имеют большое значение для того, чтобы помочь читателям понять сложную тему.

Вывод: по возможности создавайте собственные визуальные эффекты / снимки экрана, чтобы читатели могли пройти через каждую пошаговую инструкцию.
Практическое руководство по образу жизни.Еще один пример — пост на Medium под названием «11 способов быстро избавиться от стресса в вашей жизни». Ожидается, что в ней будет нескольких простых и быстрых советов, как избавиться от стресса. Но первый раздел поста — «Влияние стресса на вашу жизнь». В этом случае важно, чтобы читатели понимали, почему, а не как .

Вывод: поиграйте со структурой. Подумайте, что ваши читатели должны знать, чтобы остальная часть сообщения имела для них значение. Например, вы можете начать с раздела «Что такое …?» и «Почему … имеет значение» перед тем, как погрузиться в «Как делать …». Таким образом, ваши читатели будут полностью заинтересованы в том, чтобы узнать, как эти советы могут улучшить их жизнь в небольшом (или большом) смысле.

Шаблон для написания практического руководства можно получить как гуглдок здесь. Чтобы сохранить к себе, нажмите Файл -> Создать копию. Там же шаблоны и других материалов для блога.

Статья является адаптированным переводом https://blog.hubspot.com/marketing/how-to-guide.

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

Общие советы по созданию пользовательской документации

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

Структура руководства пользователя

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

Видео-обзор основных возможностей программы Dr.Explain

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

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

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert

Николай Вальковец, разработчик компании 2V

Прочитать кейс компании V2

Подытожим

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

Источник

Приятного чтения.

1. Качественная документация повышает лояльность клиента и ценность продукта в целом.

2. Руководство пользователя экономит время и силы техподдержки.

А теперь к советам!

Общие советы по созданию руководства пользователя

— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)

(Для изложения лучше всего выбрать нейтрально-формальный стиль)

Структура руководства пользователя

В первом разделе расскажите общую информацию о продукте. Для чего создан проект и какие задачи он решает.

Как ее сделать? Смотрите ниже.

Контент

1. Понятность.

2. Наглядность.

3. Видео.

Но как добавить в документацию видео? Смотрите ниже.

Больше советов!

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

Инструменты

Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.

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

Импортируйте в программу заранее написанные фрагменты документации.

Какой можно сделать вывод

Спасибо за внимание!

Со всеми возможностями Dr.Explain можно ознакомиться здесь:

Источник

В статье рассказывается:

Для чего нужна инструкция
Виды инструкций
5 критериев хорошей инструкции
6 этапов написания инструкции
Структура инструкции
9 советов по написанию отличной инструкции
Часто задаваемые вопросы про написание инструкций
Что делать дальше после публикации инструкции в блоге

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

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

Для чего нужна инструкция

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

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

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

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

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

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

Виды инструкций

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

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

о строительстве чего-либо или же сборке какого-нибудь предмета мебели, процессора и т. д.;
по применению;
по принятию лекарственного препарата;
лайфхак по типу «Как создать/сделать…»;
кулинарный рецепт.

Перечень не весь, но тут обозначены наиболее популярные и распространенные запросы читателей.

К отдельной категории можно отнести «специфическую инструкцию», или узконаправленную. Речь идет про материалы из разряда:

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

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

Описательные

Описательная инструкция, как правило, не несет практического характера, скорее, она рекомендательная. Ее задача рассказать, что из себя представляет объект/услуга, о функциональности, достоинствах и недостатках, возможностях и областях применения, о составе и стоимости. Например:

«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».

Сценарные

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

Еще один образец того, как можно написать сценарную инструкцию:

«Включите стиральную машину с помощью кнопки СТАРТ. Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

Для понимания различия: обзор функций нового выпущенного смартфона – описательная, инструкция по поклейке обоев – сценарная.

Кроме того, формат инструкций может быть:

текстовым;
видео;
скринкастингом – запись всех действий с экрана компьютера или смартфона;
инфографичным – каждый этап сопровождается фотографиями;
голосовым;
FAQ – сервис по часто задаваемым вопросам.

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

5 критериев хорошей инструкции

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

Как правильно написать инструкцию:

Актуальность темы

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

При публикации постов на «Хабре», например, не стоит писать о темах, ориентированных на новичков. Даже если это то, что актуально, популярностью оно пользоваться не будет. Покопайтесь в больших объемах информации и найдите цепляющее содержание. Специализированные форумы, журналы и статьи вам в помощь.
Применение в деле

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

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

Наглядная демонстрация

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

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

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

6 этапов написания инструкции

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

Поиск проблемы. Любая инструкция несет в себе решение задачи путем совершения определенных действий. Важно, чтобы проблема соответствовала общей тематике сайта или вашего блога.
Ориентирование в проблеме. Чтобы инструкция была хорошей, автор сам должен разбираться в вопросе. Это должен быть ваш опыт, а не взятый с просторов Интернета и непроверенный лично перечень действий.
План решения. Первым пунктом в этом деле будет обозначение проблемы, последним – результат описанных действий, все остальное – промежуточные шаги, которые позволили из первого пункта прийти к последнему. Главное – этапы должны быть простыми, понятными и информативными.
Подробность. Всегда можно что-то добавить на каждом этапе. Избегайте «воды», четко и объемно формулируйте идею каждого пункта.
Визуал. Добавляйте в инструкцию инфографику, фото и изображения, которые упростят процесс понимания каждого этапа. Однако имейте в виду, что визуальное сопровождение может быть уместным не везде. Например, в статье «Как правильно написать инструкцию по применению лекарственного препарата», перегруженность фотографиями станет лишней.
Советы и рекомендации. Люди доверяют больше опыту и жизненным советам, чем сухому тексту с алгоритмом действий. Используйте это там, где необходимо.

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

Кейс: VT-metall

Узнай как мы снизили стоимость привлечения заявки в 13 раз для металлообрабатывающей компании в Москве

Узнать как

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

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

План выглядит следующим образом:

Цель статьи

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

Не всегда это бывает просто. Как правило, название материала соответствует самим запросам пользователей, например: «В каком порядке смотреть фильмы Марвел», но если кроме релевантности заголовок еще будет цепляющим, это – гарантированный успех статьи. Очень эффективно срабатывают заголовки, начинающиеся с цифр, и лучше всего использовать не круглые числа типа 10, 20, а нечетные 12, 23, 7 и т. д.
Введение, или лид

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

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

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

9 советов по написанию отличной инструкции

Чтобы ответить на главный вопрос сегодняшней статьи – как написать инструкцию – важно учитывать следующие особенности ситуации.

Оцените уровень знаний читателя

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

Смотрим на целевую аудиторию:

Это известный фермер, работающий в лаборатории Илона Маска и готовящийся к высадке данной культуры на Марсе?
А может – огородник в возрасте, не готовый переплачивать за удобрения и тепличное оснащение?
Ученик пятого класса, который делает практическую работу по биологии?

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

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

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

Проверьте, есть ли уже подобные инструкции

В Интернете есть огромное количество информации по любой теме, потому необходимо узнать, есть ли уже в Сети подобный материал. Если есть: что бы вы могли взять из этой статьи на вооружение? Списывать и адаптировать каждый пункт под себя не надо, просто прочтите ее полностью и почерпните важные моменты, которые, возможно, упустили. Зафиксируйте их в заметках, подумайте, что бы можно к ним добавить еще или убрать.

Готовьте серию инструкций

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

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

Проверяйте инструкции

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

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

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

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

Не переписывайте чужие инструкции

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

Отжимайте лишнюю «воду»

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

Неудачно написанная инструкция начинается примерно так:

У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.

Как правильно написать инструкцию в этом случае:

В данном гайде вы найдете 11 простых способов рисования круга в «Фотошопе». Руководство подойдет для версии СС 2015 и выше.

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

Без картинок – никуда

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

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

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

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

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

Выдерживайте статью в одном стиле

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

Пример неверного написания:

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

Образец, как надо написать инструкцию, чтобы она была читабельной:

Цвет — это инструмент управления вниманием пользователя: он помогает выделять главное. В интерфейсе краски используются для передачи смысла, а не для оформления.

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

Неправильно (т. к. нет никакого четкого пояснения):

В интерфейсах должна быть простая и понятная навигация.

Старайтесь избегать местоимения «мы», по возможности.

Запреты тоже могут быть нескольких типов. Используйте каждый там, где это необходимо:

Самый мягкий вариант – «Не рекомендуется делать подобным образом».
Средний вариант – «Так поступать нельзя».
Категоричный и жесткий вариант – «Строго запрещено делать подобное».

Не забывайте «оживлять» инструкцию, объясняя, почему так делать не рекомендуется или, наоборот, делать сто́ит, приводите примеры, факты и делитесь опытом из вашей жизни.

Не забывайте о безопасности

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

Скачайте полезный документ по теме:

Чек-лист: Как добиваться своих целей в переговорах с клиентами

Часто задаваемые вопросы про написание инструкций

Каким категориям бизнеса рекомендуется использовать инструкции?

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

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

Чем инструкция отличается от обзора?

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

Заголовки статей типа: «Как выбрать автомобиль…» больше подойдут под жанр инструкции, так как будут содержать в себе подробный алгоритм действий, по которым можно выбрать то, что потенциальному покупателю нужно.

Как узнать, для какой аудитории пишется инструкция?

Как написать правильную пошаговую инструкцию, которая понравится потребителю? Все просто – пообщайся с клиентом.

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

Какой объем инструкции считается оптимальным?

По большому счету, это зависит от автора и самой темы инструкции, но, как показывает практика, чем короче руководство, тем лучше. Есть возможность уместить объяснение в одно-два предложения? Прекрасно! Читатели оценят.

Что делать дальше после публикации инструкции в блоге

Как написать инструкцию, мы разобрали, но что же делать, когда текст готов, проверен редактором, логичен, информативен и даже уже поставлен в пост? Для развития контента и увеличения трафика необходимо соблюдать следующее:

Регулярность выхода

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

Email-рассылки

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

Взаимодействие с читателями

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

Возможность оценки контента

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

Возможность делиться инструкциями

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

Сотрудничество с другими авторами

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

Анализ инструкций

Анализ контента – важный фактор в успешном продвижении блога, в котором публикуются инструкции, лайфхаки и обзоры. Есть масса инструментов, способных в этом посодействовать, например, Яндекс.Метрика – раздел «Контент».

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

Подгрузка видео из YouTube

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

Наличие подкастов или голосовой записи инструкций

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

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

Статья опубликована: 01.03.2022

Облако тегов

Понравилась статья? Поделитесь:

Источник