Шаблон для инструкции по применению

Как разработать и написать хорошее руководство пользователя, если вы не технический писатель?

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

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

При открытии программы на главном экране выберите один из интересующих вас шаблонов: (Руководство пользователя ПО, Руководство пользователя Web-сервиса, Корпоративная база знаний). Они находятся в разделе «недавние проекты»

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

Если вы считаете, что в программе не хватает нового специфического шаблона и он может быть полезен многим пользователям, мы готовы разработать такой шаблон. Пожалуйста опишите вашу задачу и поделитесь своими мыслями, шаблон какого документа был бы полезен для вас. Ждем ваших писем на: help@drexplain.com

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

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

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

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. Нажмите на изображение, чтобы перейти на страницу с руководством.

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

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

Выделяются следующие виды инструкций:

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

К инструкциям также относятся и иные нормативные акты, а именно:

• правила;
• рекомендации;
• «методички».

По сфере применения инструкции подразделяются на:

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

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

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

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

В свою очередь, должностные инструкции делятся на типовые и конкретные. Так:

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

Составляется инструкция на каждую единицу штатного расписания.

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

Все инструкции содержат в себе примерно одинаковый набор структурных компонентов, а именно:

1. наименование органа, принявшего инструкцию;
2. реквизиты инструкции – номер, дата издания, наименование документа, сведения о согласовании, место издания и гриф об утверждении инструкции;
3. заголовок, содержащий предельную конкретику по кругу вопросов, на которые распространяется инструкция. Например: «Должностная инструкция охранника цеха» или «Инструкция по делопроизводству на заводе «Сигнал»»;
4. текст, подразделяемый на разделы, пункты, подзаголовки и т.д. в соответствии с Госсистемой стандартизации РФ. Начинается текст обычно с «Общих положений», в которых перечисляются цели инструкции, ее задачи, сфера применения, срок введения в действие, обязательный характер, нормативные акты, на базе которых была разработана инструкция, требования по квалификации работника. Если инструкция принимается взамен устаревшей, то в «Общих положениях» указывается и то, что старая инструкция теряет свою силу;
5. функции должности, состоящие из перечисления видов работы, входящей в обязанности работника. Функции можно оформить как в виде отдельного раздела, так и включить их в общие положения;
6. должностные обязанности. В известной степени этот раздел дублирует функции. К должностным обязанностям относится перечень конкретных операций, выполняемых работником – руководит, охраняет, наблюдает, контролирует и т.д.;
7. права. В этот перечень входят полномочия конкретной должности – например, полномочия давать указания, полномочия по подписанию документов, полномочия по допуску к закрытой информации, по участию в совещаниях и т.д. Могут быть включены также и некие общие права работника, например, право на 10-минутный отдых каждый час или право повышать свою квалификацию;
8. ответственность работника. В перечень входят, как правило, материальная, дисциплинарная, уголовная и административная виды ответственности за невыполнение конкретных обязанностей, например, за хищение, за порчу, за непринятие своевременных мер, невыполнение приказа и т.д.;
9. раздел «Взаимоотношения», в который включается способ и пределы взаимодействия работника с другими структурами предприятия или организации;
10. допускается включение в текст инструкции раздела об оплате труда, но без дублирования условий трудового договора. Например, в инструкции можно перечислить виды премий, на которые может претендовать работник, виды надбавок, условия повышения оклада и т.д.;
11. завершается инструкция, как правило, разделом «Оценка работы». В этом разделе регламентируются способы оценки достижений в работе.

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