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

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

инструкции для сотрудников

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

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

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

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

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

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

Пошаговое руководство

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

  1. Откройте верхнюю крышку и извлеките блок фотобарабана
  2. Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
  3. Вытащите тонер-картридж
  4. Поставьте на его место новый
  5. Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
  6. Установите фотобарабан обратно в принтер
  7. Закройте крышку
  8. Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает обратитесь к системному администратору

Инструкция по использованию

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

инструкция по использованию

В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:

  • В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic 160-180°C.
  • Максимальное время работы ламинатора 4 часа. Затем нужно сделать получасовой перерыв.
  • Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его. 
  • Внимание! Не ламинируйте влажные образцы жидкость может повредить электронные компоненты!
  • После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством. 
  • Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию! 

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

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

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

Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:

  1. Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
  2. При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
  3. Бригадир раздает списки, по которым комплектуются грузы. 
  4. Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
  5. Если есть необходимость, грузчик может привлекаться к другим работам на территории склада уборке, контролю за въездом транспорта и пр.

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

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

Общие правила при подготовке инструкций

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

  • Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
  • Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
  • Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
  • Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
    Как структурировать много данных →
  • Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта

Алгоритм разработки руководства: 9 шагов

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

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

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

Шаг 1. Изучить ситуацию

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

Шаг 2. Разложить все на отдельные этапы

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

  1. Запустить программу Microsoft Word
  2. Создать новый документ
  3. Набрать необходимый текст
  4. Отформатировать его 
  5. Сохранить файл
  6. Сообщить в бухгалтерию, что заявление подготовлено 

Шаг 3. Описать каждый этап

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

Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:

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

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

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

Шаг 4. Рассмотреть нестандартные варианты развития ситуации

Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:

3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры 

Шаг 5. Подобрать изображения и привести примеры

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

Шаг 6. Придумать заголовок

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

  • «Как написать инструкцию по подготовке заявления»
  • «6 шагов для подготовки электронного документа»
  • «Простой способ написать заявление на компьютере»
  • «Подробный алгоритм подготовки документа для безбумажного оборота»

Шаг 7. Оценить промежуточный вариант

В результате должен получиться подобный текст:

Как написать простую инструкцию (образец): 

  1. Запустите программу Microsoft Word
  2. Нажмите на раздел «Новый документ» в правой части экрана 
  3. Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
  4. Отформатируйте набранный текст с помощью верхней панели программы Word.
    • Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
    • Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
    • Выделите список спецодежды и примените к нему функцию «Маркированный список» 
  1. Сохраните файл. Для этого:
    • Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
    • Выберите путь сохранения файла
    • В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
    • Нажмите кнопку «Сохранить»
  2. Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено. 

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

Шаг 8. Тестирование

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

Проверьте алгоритм с помощью этих вопросов:

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

Шаг 9. Обучить сотрудников по инструкции

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

Особенности такого обучения:

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

Примеры готовых инструкций

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

Вывод

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

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

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

агрегаторы курсов

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

как учиться эффективно

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

платформы для вебинаров

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

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

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

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

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

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

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

image

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Таким образом все три понятия — процесс, регламент и инструкция — являются взаимосвязанными. Эти термины используются в современном менеджменте по управлению процессами организации — 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 ШАГОВ

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

  1. Идентифицируйте процесс, этап и задачу, для выполнения которой вы создаете рабочую инструкцию;***
  2. Определите результат, который должен получить сотрудник как итог выполнения задачи;***
  3. Оцените масштаб задачи;***
  4. Определите функционал сотрудника, который должен отвечать за выполнение задачи, и его должность;***
  5. Определите (или разработайте) необходимые инструменты, необходимые для выполнения задачи;***
  6. Упомяните о любых требованиях безопасности (для производственного процесса);***
  7. Выберите подходящий и удобный формат изложения текста;
  8. Используйте полезные наглядные пособия;***
  9. Проверьте текст на предмет простоты и краткости изложения;
  10. Удалите ненужный жаргон и технические термины;***
  11. Проверьте инструкцию на сотруднике, который ее будет исполнять;***
  12. Исправьте ошибки.

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

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

author__photo

Содержание

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

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

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

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

caltouch-platform

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

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

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

platform

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

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

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

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

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

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

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

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

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

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

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

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

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

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

caltouch-platform

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

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

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

platform

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

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

Мой Телеграм

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

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

Этап №1. Как подготовиться к написанию инструкции

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

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

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

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

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

Этап №2. Как правильно писать инструкцию

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

  • Краткость – главная ценность инструкции. Не стремитесь украшать текст метафорами и деепричастными оборотами: сокращайте текст до смысла. Позволить себе лирические отступления можно только в виде шутки или примечания о распространенных ошибках.
  • Последовательность. Начинайте с… начала. Удивительно, но многие почему-то начинают писать инструкцию едва ли не с середины. Например, так: «в папке «Мои документы» откройте файл…» — учитывайте, что пользователь с минимальным уровнем знаний наверняка не знает, где искать ту самую папку. Объясните, где она находится.
  • Не допускайте пропуска шагов. Некоторые авторы явно думают, как написать инструкцию для себя, а не для кого-то – они пропускают легкие (на их взгляд) шаги, из-за чего у читателя возникает легкая растерянность, а иногда и ошибки в выполнении задачи. Не пропускайте даже малейших деталей!
  • И еще раз о терминологии. Если обойтись без нее нельзя, напишите приложение к инструкции – словарь. Либо поясняйте их прямо по тексту.
  • Не лейте воду. Пошаговое руководство – именно тот жанр, где не требуется долгих лирических вступлений и разглагольствований на тему «всем известно, что» или «а в Древнем Риме было так» — в двух предложениях поясните смысл или повод для написания инструкции и сразу же переходите к делу.
  • Наглядность. Основная цель статьи-инструкции – помочь человеку справиться с какой-либо задачей. Поэтому инфографика здесь играет особую роль. Желательно проиллюстрировать каждый шаг скриншотами или картинками, вырезанными из видео. Неплохим приложением станет и качественный ролик из YouTube, который легко внедряется на любой сайт.
  • Предостерегайте. Если вы знаете, что на каком-то шаге выполнения люди часто делают ошибки – сделайте сноску с предупреждением о возможных ошибках.

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

Руководство, инструкция, как писать, как правильно написать руководство, инструкцию

Немного о логической структуре инструкций

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

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

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

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

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

Этап №3. Проверка инструкций: читабельность, доступность и фактчекинг

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

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

Руководство, инструкция, как писать, как написать

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

Содержание

  • Зачем писать инструкции для сотрудников
    • 1. Обучение новых сотрудников
    • 2. Конфликтные ситуации
    • 3. Носители уникальных знаний 
  • Решение есть: инструкции
  • Как написать инструкции для сотрудников
    • Техника “диктофон”
    • Принцип здравого смысла
  • Когда нужно писать инструкции для сотрудников
  • Структура инструкций для сотрудников
  • Как внедрить инструкции для сотрудников

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

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

Зачем писать инструкции для сотрудников

1. Обучение новых сотрудников

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

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

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

2. Конфликтные ситуации

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

3. Носители уникальных знаний 

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

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

Решение есть: инструкции

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

Как написать инструкции для сотрудников

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

Техника “диктофон”

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

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

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

Принцип здравого смысла

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

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

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

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

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

Когда нужно писать инструкции для сотрудников

Смена должности

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

Повышение

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

Проблемные области

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

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

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

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

Памятки

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

Должностные инструкции

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

Структура инструкций для сотрудников

Вступление

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

Тело регламента

Сам регламент. Детальное описание действий и результата. Сама инструкция к действию.

Успешные примеры

Опишите успешные примеры применения данного регламента

Неуспешные кейсы

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

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

Как внедрить инструкции для сотрудников

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

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

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

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

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

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

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

Каждый программный продукт нуждается в руководстве пользователя

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в 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 активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Создание руководства пользователя по ГОСТ 34 и ГОСТ 19

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

Руководство к программе 2V Стоматология

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


Подытожим

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

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

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

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

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

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

Итак, начнем с того, что условно гайды делятся на два типа:

  • Полное руководство, в котором рассказывается о каком-то сервисе или действии. Пример — создание группы во «ВКонтакте» с нуля, инструкция по пользованию линейкой готовых решений IntecUniverse.
  • «КАК-руководство» отвечает на конкретный вопрос. Пример — как настроить Google Диск, как почистить серебро, как приготовить лазанью и пр.

Определитесь с ЦА

Первый вопрос — кто будет читать гайд? Руководство для новичков — это одно. Гайд для тех, кто уже умеет что-то делать и хочет прокачать скилл, — совсем другое.

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

Выдержка из руководства по украшению дома к Новому году

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

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

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

Вот пример неудачного вступления:

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

Надо вот так:

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

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

Очень много вступлений, речевых оборотов и т.д.

Кратко или подробно: ищите баланс

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

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

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

Для сравнения:

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

И вот так:

Нарушите инструкцию — песец всему.

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

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

Помните о структуре

«Нет» длинным абзацам. Абзацы больше 6 строк лучше разбивать на две части — так текст читается легче.

Используйте списки. Надо что-то перечислить — делайте список, даже короткий, даже всего из трех пунктов.

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

Чтобы что-то сравнить, создавайте таблицы.

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

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

Вместо тысячи слов — картинка. Можно интересно писать, но лучше показывать. Например, вы рассказываете о каком-нибудь устройстве. На правой панели прибора в верхней части с левой стороны есть большая желтая кнопка, которую надо нажать. Что проще: объяснять словами или сделать фото и обвести кнопку кружком? Конечно, сделать фотографию.

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

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

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

Пример гифки о редактуре от Максима Ильяхова

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

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

Ссылки

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

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

Клик на выделенное слово направит вас на другую статью по теме

Этот рецепт работает и с полными руководствами. Не размещайте огромное текстовое полотно на одной странице, а разбивайте его на разделы с грамотной перелинковкой. Google и Яндекс именно так и устроили гайды для своих сервисов.

Заключение

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

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


Загрузить PDF


Загрузить PDF

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

Шаги

  1. Изображение с названием Write a Manual from Scratch Step 1

    1

    Укажите тему. Будьте точны в ее границах и сфере.

  2. Изображение с названием Write a Manual from Scratch Step 2

    2

    Определите, для кого готовится инструкция.

    • Вы пишите для новичков, профессионалов или для кого-то со средними знаниями?
    • Вашу инструкцию будут использовать на групповых занятиях или для самостоятельного изучения?
  3. Изображение с названием Write a Manual from Scratch Step 3

    3

    Точно определите, о чем будет сказано в инструкции.

    • Пример: Вы готовите руководство «Как установить двери». Один раздел может быть посвящен дверям-купе, другой – входных дверям, еще один – дверям для черного входа.
  4. Изображение с названием Write a Manual from Scratch Step 4

    4

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

  5. Изображение с названием Write a Manual from Scratch Step 5

    5

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

    • В глоссарии нужно использовать максимально точные описания терминов. Если используется акроним, объясните его значение (например, Scuba – «Self Contained Underwater Breathing Apparatus» автономный аппарат подводного дыхания).
  6. Изображение с названием Write a Manual from Scratch Step 6

    6

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

  7. Изображение с названием Write a Manual from Scratch Step 7

    7

    Подумайте об организационной структуре каждого раздела.

    • Пример: Вы готовите инструкцию об определенных компьютерах. В этом руководстве может быть раздел «Устранение проблем». Часть материала в нем можно посвятить проблемам с дисковым пространством, другую – чрезмерному использованию оперативной памяти и т.д.
  8. Изображение с названием Write a Manual from Scratch Step 8

    8

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

  9. Изображение с названием Write a Manual from Scratch Step 9

    9

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

    1. Напишите описание разных заданий.
    2. Подготовьте примеры, выполняя которые читатель лучше поймет инструкцию.
    3. Подготовьте соответствующие иллюстрации. Не вставляйте рисунки, пока инструкция не написана. Иллюстрации необходимо подогнать под размеры текста.
    • Внесите изменения, чтобы облегчить читателю поиск необходимой информации.
      1. Пример 1: (Используйте нумерованный список) В редакторе можно привязать рисунок к пункту 13-му параграфу инструкции.
      2. Пример 2: (Сортировка) В редакторе можно увеличить размер текстовой строки, если она выделяется из общего порядка.
  10. Изображение с названием Write a Manual from Scratch Step 10

    10

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

    • Ничто не разрушает доверие к автору быстрее, нежели плагиат. Подумайте, что бы вы чувствовали, когда кто-то «украдет» часть вашей работы для своей инструкции?
  11. Изображение с названием Write a Manual from Scratch Step 11

    11

    Добавьте соответствующие иллюстрации. Расположите их в тексте. Не бойтесь оставлять пустое пространство.

  12. Изображение с названием Write a Manual from Scratch Step 12

    12

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

      • Лучший, по нашему мнению, порядок проверки готовой инструкции:
        1. Вычитайте ошибки самостоятельно.
        2. Попросите друга проверить ошибки.
        3. Дайте работу на проверку специалисту в данной области, чтобы он также проверил ее.
        4. Если инструкция готовится для вашей компании, попросите начальника проверить ее.
        5. Дайте работу на проверку новичку.
        • Проверка неопытным специалистом поможет понять, насколько понятно изложен текст для людей, у которых в данной области минимум знаний.

    Реклама

Советы

  • Убедитесь, что на титульной странице и в нижнем колонтитуле каждой страницы указана ваша фамилия, как автора руководства. Распечатайте копии инструкции до того, как отсылать ее по электронной почте. Включите знак копирайта (с) в нижнем колонтитуле. Можете набрать (с), и большинство текстовых редакторов автоматически исправит это на нужный символ. В результате нижний колонтитул будет выглядеть «© Ваше Имя». Это не помешает компании копировать инструкцию, но вы сохраните свое авторство.

Реклама

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

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

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

Понравилась статья? Поделить с друзьями:
  • Инструкция по эксплуатации мультиварки редмонд rmc m291
  • Hemo him корейский препарат инструкция по применению для чего применяется
  • Раствор клиндезин экстра инструкция по применению
  • Функции брелка томагавк 9010 инструкция по эксплуатации
  • Оксолин гель инструкция по применению цена отзывы