Бизнес-процессы организации иногда требуют создания руководящих документов, отличных от классических положений, регламентов, инструкций, правил или методических указаний. Директор, доведенный до бешенства хаосом в организации или отделе, может поручить вам составить документ с подробнейшим описанием порядка выполнения всех ключевых действий. В статье объясним, что такое руководство, в каких случаях его нужно создать и как именно это сделать.
Виды руководящих документов
При описании тех или иных процессов, действий и взаимодействий подразделений и работников, которые занимают определенные должности и исполняют ряд трудовых функций и обязанностей, часто используют такие виды руководящих документов, как положения, регламенты, инструкции, правила, методические указания. У каждого из перечисленных документов есть свое назначение (Таблица 1).
Что такое руководство и зачем оно нужно?
Кажется, что для нужд предприятия, документов, перечисленных в Таблице 1, достаточно. Но иногда требуется создать иной руководящий документ – руководство. Рассмотрим на конкретном примере, когда он может понадобиться.
Опишу ситуацию, которая однажды сложилась в нашей организации. Работники складов, имея на вооружении инструкции и правила, в которых описаны различные рабочие процессы (приемка товара по качеству и количеству, выдача товара покупателю, набор товара для отправки в региональные склады, работа с некондиционным товаром, работа с неликвидами, работа с вилочными погрузчиками и т.д.), часто ходили в грязной и рваной спецодежде (сменные комплекты чистой и целой одежды всегда есть) либо вообще не носили спецодежду, заменяя ее чем придется из домашнего гардероба, забывали своевременно освобождать помещение склада от использованной тары и упаковочных материалов, несколько раз забывали запирать склад на ночь.
Да, в организации действовали приказы, предписывающие носить на рабочих местах только выданную спецодежду установленного образца, менять ее еженедельно, а также правила сдачи и снятия помещения «на охрану». Но возникла надобность в едином документе, который объединил бы все уже расписанные действия сотрудников в единое целое буквально по шажочку. Что сделать вначале: отпереть дверь ключом или снять помещение с охранной сигнализации? Переодеть штаны или включить на складе свет? Как часто выбрасывать мятую упаковочную бумагу – после вскрытия каждой упаковки или после вскрытия десяти упаковок? Что делать, если покупатель, получающий товар, упал в обморок?
Думаю, понятно, что многие из заявленных «непоняток» были очень похожи на простой саботаж, которым иногда не брезгуют работники. Дескать, а где написано, что я должен сначала выдать товар покупателю, а уж потом подметать пол на складе? Я хочу сначала подмести, у меня и в инструкции написано: «удалить из помещения склада использованные упаковочные материалы и тару», и пусть весь мир подождет! Или что я должен сделать вначале: выключить освещение в помещении склада или пойти переодеваться?
И так может продолжаться бесконечно. Важно, что вопросы и надуманные нестыковки различных действий доводятся до абсурда и мешают производственному процессу.
После некоторого размышления в нашей организации было принято решение создать руководящий документ, который устранил бы все «непонятки», связал бы различные процессы, расставил бы акценты и приоритеты при выполнении различных действий. Кроме того, была поставлена задача написать этот документ как можно подробнее, что в устах доведенного до бешенства руководства звучало «как для дураков». Содержание и назначение документа не подпадало ни под одно определение руководящих документов, поэтому я назвала его «Руководство», так как формат руководства пользователя, прилагаемого, например, к приобретаемой бытовой технике, наиболее точно подходил к задаче.
Структура руководства для работников подразделения
Руководство для работников подразделения – это документ, описывающий работу подразделения в целом, который устанавливает и регулирует общий порядок работы по всем направлениям деятельности и включает в себя основные алгоритмы действий работников на протяжении рабочей смены, расставляет приоритеты выполнения различных процессов.
Структура руководства не регламентирована, но в целом имеет много общего со структурой других руководящих документов – положения, регламента (Схема 1).
Раздел «Общие положения»
Обычно в разделе «Общие положения» любого документа указываются:
1. Назначение (цель) документа.
2. Область применения.
3. Нормативные ссылки (или нормативные документы).
4. Связанные документы, локальные нормативные акты.
5. Глоссарий (термины и сокращения).
6. Порядок утверждения руководства, внесения в него изменений и его отмены.
Назначение (цель) документа
В написании этой части применяется стандартная фраза для всех руководящих документов подобного вида, например:
1.1. Настоящее руководство устанавливает и регулирует общий порядок работы персонала склада.
Также можно использовать такую формулировку:
1.1. Цель настоящего руководства – установление и регулирование общего порядка работы склада.
Область применения
В этом абзаце следует указать наименования и коды подразделений (если они есть), которых касается это руководство. Поскольку мы пишем документ для работников одного конкретного подразделения, то эту часть можно опустить. Но если руководство затрагивает и другие подразделения, то следует указать, какие именно. Например, так:
1.2. Область применения документа:
– складское хозяйство;
– транспортный отдел.
Нормативные ссылки (или нормативные документы)
Здесь необходимо указать нормативные документы, которые использовались при разработке этого руководства, а именно: действующие государственные, отраслевые стандарты, кодексы Российской Федерации, методические рекомендации по внедрению государственных стандартов, действующие приказы и постановления государственных органов и т.д.
Например, для создания руководства для работников склада эта часть может выглядеть следующим образом:
1.3. Нормативные документы:
1. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по количеству (утв. Постановлением Госарбитража СССР от 15.06.1965 № П-6).
2. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по качеству (утв. Постановлением Госарбитража СССР от 25.04.1966 № П-7).
Материал публикуется частично. Полностью его можно прочитать в журнале «Секретарь-референт» № 8, 2021.
Чтобы объяснить человеку как выполнять задачу или работать с инструментом, нужно составить понятную инструкцию. Неизвестная компьютерная программа или новые функции на работе – все это требует разъяснений для успешного взаимодействия. В статье рассмотрим, как правильно написать инструкцию.
Инструкция – это документ, который объясняет способы или правила выполнения определенных действий. А понятная инструкция делает то же самое, но простым языком. Многие руководства написаны очень сложно и люди предпочитают не заглядывать в них, пока что-то не сломается.
Однако такой подход может привести к не самым лучшим последствиям. Например, работник не изучил правила по работе на буровой установке или неверно понял описанный материал, и получил травму из-за неправильного использования техники. Поэтому важно ответственно подойти к составлению и разобраться, как правильно написать инструкцию.
3 основных вида инструкций
Есть несколько типов инструкций. Они предназначены для разных целей, но разрабатываются по схожим принципам. К примеру – уяснив, как написать инструкцию по работе системного администратора, вы легко сможете применить эти знания и при подготовке руководства по использованию мини-АТС.
Пошаговая инструкция
Такие руководства позволяют регламентировать все возможные повторяющиеся процессы. Поставленная задача разбивается на несколько этапов, и каждый этап дополняется пояснениями. Примеры таких инструкций – пошаговые алгоритмы составления бухгалтерской отчетности, подключение к удаленному рабочему столу или действия при пожаре.
Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:
- Откройте верхнюю крышку и извлеките блок фотобарабана
- Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
- Вытащите тонер-картридж
- Поставьте на его место новый
- Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
- Установите фотобарабан обратно в принтер
- Закройте крышку
- Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает – обратитесь к системному администратору
Инструкция по использованию
Это перечень рекомендаций по правильному использованию приборов, например, руководство к сканеру штрих-кодов. Такие мануалы будут полезны пользователям непростых устройств — на рабочем месте или в быту.
В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:
- В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic – 160-180°C.
- Максимальное время работы ламинатора – 4 часа. Затем нужно сделать получасовой перерыв.
- Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его.
- Внимание! Не ламинируйте влажные образцы – жидкость может повредить электронные компоненты!
- После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством.
- Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию!
Должностная инструкция
Так называют документ, регулирующий сферу обязанностей для конкретной должности. Также здесь определены права работника, требования к квалификации, область ответственности и формы премирования. Должностные инструкции могут быть составлены для любого сотрудника – от уборщицы до генерального директора. Их готовят совместно с юристом.
Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:
- Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
- При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
- Бригадир раздает списки, по которым комплектуются грузы.
- Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
- Если есть необходимость, грузчик может привлекаться к другим работам на территории склада – уборке, контролю за въездом транспорта и пр.
Должностная инструкция – это скорее юридический документ, чем пользовательский. А чтобы понятным языком проинструктировать сотрудника по его работе, обычно составляют отдельное обучение – «Пособие по должности». В нем подробно рассказывают о роли и ценном конечном продукте, описывают систему мотивации, метрики и алгоритмы выполнения работы. И размещают эти материалы на платформе для онлайн-обучения.
Ниже вы можете получить готовую структуру обучения для курса «Пособие по должности».
Общие правила при подготовке инструкций
Для подготовки любого типа руководств используются одни и те же приемы работы с информацией. Вот рекомендации, которые подскажут как написать хорошую инструкцию:
- Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
- Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
- Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
- Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
Как структурировать много данных → - Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта
Алгоритм разработки руководства: 9 шагов
Рассмотрим, как написать доступную инструкцию для сотрудников на примере описания алгоритма действий. Особенность этого руководства в том, что для него нужно не только перечислить отдельные действия, а установить их в правильной последовательности, чтобы привести читателя к нужному результату. В общем случае необходимо:
- Собрать информацию
- Сгруппировать ее по отдельным этапам
- Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя
В качестве примера возьмем ситуацию, когда организация перешла на электронный документооборот. При этом часть сотрудников не умеет работать с программой Microsoft Word и нужно объяснить им, как подготовить заявление о выдаче спецодежды.
Шаг 1. Изучить ситуацию
Конечно, вы не один год используете Word и легко можете подготовить требуемое заявление. Но в данном случае нужно взглянуть на проблему глазами пользователя – человека, который впервые сталкивается с этой программой. Поэтому нужно не опираться на текущие знания по работе в Word, а самостоятельно проделать весь путь заново. С большой вероятностью вы откроете для себя что-то новое – ведь раньше многие операции выполнялись автоматически. Сходу очень трудно вспомнить, как называлась «та кнопка для создания списка» и другие детали.
Шаг 2. Разложить все на отдельные этапы
Задача этого шага – создать предварительный план решения задачи. Такой алгоритм начинается с исходной ситуации и заканчивается достижением результата. В начало каждого пункта поставьте глагол, определяющий ключевое действие этого шага:
- Запустить программу Microsoft Word
- Создать новый документ
- Набрать необходимый текст
- Отформатировать его
- Сохранить файл
- Сообщить в бухгалтерию, что заявление подготовлено
Шаг 3. Описать каждый этап
Здесь нужно конкретизировать каждый шаг, необходимый для достижения поставленной цели. При этом не усложняйте описание. Если действие можно выполнить несколькими способами, опишите только один вариант, максимум два – тогда читатель с меньшей вероятностью запутается.
Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:
2. Нажмите на раздел «Новый документ» в правой части экрана
Если руководство предназначено для новичков, избегайте профессиональной лексики. В нашем примере лучше обойтись без понятий «Интерфейс» и «Строка состояния». Важно понимать, что вы пишете не теоретический учебник для передачи системных знаний, а практическое руководство, по которому человек сможет здесь и сейчас выполнить действия и достичь результата. Если не обойтись без терминов и аббревиатур, поясните их.
Совет. Старайтесь не нагромождать вашу инструкцию ненужными действиями. Например, лишней будет информация о том, какой шрифт использовать для заявления – в большинстве случаев пользователь столкнется с шаблоном Normal, где стоит подходящий Calibri размером 11 пунктов.
Шаг 4. Рассмотреть нестандартные варианты развития ситуации
Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:
3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры
Шаг 5. Подобрать изображения и привести примеры
Если можно проиллюстрировать какую-то операцию – обязательно сделайте это. Для рецептов блюд подойдут снимки каждого шага, а для инструкций по сборке – взрыв-схемы (эскизы, на которых вся конструкция разобрана на детали и они разнесены в разные стороны). А чтобы наглядно показать работу в компьютерной программе, следует подготовить скринкасты или скриншоты с пояснениями.
Шаг 6. Придумать заголовок
Даже если вы написали руководство для внутреннего пользования, а не для публикации в интернете, яркий заголовок привлечет внимание и настроит на выполнение нужной работы. Вот несколько вариантов для нашего примера:
- «Как написать инструкцию по подготовке заявления»
- «6 шагов для подготовки электронного документа»
- «Простой способ написать заявление на компьютере»
- «Подробный алгоритм подготовки документа для безбумажного оборота»
Шаг 7. Оценить промежуточный вариант
В результате должен получиться подобный текст:
Как написать простую инструкцию (образец):
- Запустите программу Microsoft Word
- Нажмите на раздел «Новый документ» в правой части экрана
- Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
- Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»
- Сохраните файл. Для этого:
- Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
- Выберите путь сохранения файла
- В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
- Нажмите кнопку «Сохранить»
- Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено.
Пример объявления, на который можете ориентироваться при подготовке:
Шаг 8. Тестирование
Внимательно проверьте инструкцию на логические ошибки. Желательно, чтобы коллеги или знакомые взглянули на нее со стороны. Еще лучше – когда неопытный человек изучает составленный алгоритм и пытается с его помощью добиться желаемого результата.
Проверьте алгоритм с помощью этих вопросов:
- Понятен ли указанный порядок действий? Да, мы улучшали его в шагах 2-5
- Все ли нюансы учтены? Да, последовательность шагов охватывает всю необходимую процедуру
- Есть ли в алгоритме сложные этапы, которые можно разбить на несколько частей? Нет, все они были скорректированы на предыдущих шагах
- Достигнут ли результат? Будет ли он неизменным при разных условиях использования алгоритма? Да, на выходе мы получаем файл для безбумажного оборота. При правильном следовании приведенной последовательности, результата можно достичь вне зависимости от того, кто составляет заявление – грузчик или уборщица
Шаг 9. Обучить сотрудников по инструкции
Если руководство предназначено для сотрудников компании, важно проконтролировать, что они изучили ее. Для этого загрузите инструкцию для персонала на платформу Unicraft, назначьте на нее работника и отслеживайте его прогресс.
Особенности такого обучения:
- Информация сопровождается рисунками, схемами, анимацией, формами обратной связи – это увлекательнее, чем простое чтение текста
- В режиме реального времени руководитель может видеть, какое количество материала уже изучено
- В конце разделов и всего курса предусмотрены контрольные вопросы. Процент правильных ответов для успешного прохождения курса можно задавать самостоятельно (обычно он составляет 80%)
Примеры готовых инструкций
Ниже приведены примеры инструкций по пользованию платформой Unicraft. Нажмите на изображение, чтобы перейти на страницу с руководством.
Вывод
Резюмируя все изложенное, можно составить требования к идеальной инструкции:
- Актуальность. В тексте нет устаревших сведений
- Информативность и целостность. Подготовленное руководство содержит все необходимые сведения
по обозначенной теме. У пользователя не остается вопросов - Лаконичность. Приоритеты для составителя – это точность формулировок и отсутствие второстепенных сведений. Часто бывает, что инструкцию смотрят в сложных ситуациях, когда нужно быстро получить ответ на возникший вопрос
- Наглядность. Информация сопровождается примерами и иллюстрациями
- Конкретный результат. Руководство помогает получить конечное решение
- Соотносимость с текущими знаниями пользователя. Чем ниже уровень знаний аудитории, тем подробнее объяснения
- В тексте нет сложных конструкций. Они разбиты на несколько частей. Каждый пункт списка – это отдельное действие, которое дополняется комментариями и пояснениями
Вам будет интересно
Как создать онлайн тест: подробное руководство
План обучения менеджера по продажам
Оценка эффективности обучения персонала: проверенный алгоритм
Перейти на главную блога
Документ, в котором прописаны пошаговые действия пользователя по сборке и использованию того или иного устройства, может иметь разные названия: паспорт по эксплуатации, руководство по эксплуатации, руководство по монтажу, инструкция по применению и так далее. Но формально правильнее называть документ руководство по эксплуатации или паспорт по эксплуатации. Часто также применяется аббревиатура РЭ.
Руководство по эксплуатации входит в состав технико-эксплуатационной документации изделия. Туда также входят такие документы, как технический паспорт, каталог деталей, формуляры и многое другое.
Основная цель паспорта или руководства по эксплуатации – ознакомить пользователя с принципами работы технического устройства или оборудования, его монтажом, обслуживанием и ремонтом.
Содержание руководства по эксплуатации
Руководство или паспорт по эксплуатации разрабатывается, принимая за основу ГОСТ 2.601-2019, в котором описаны принципы разработки разной эксплуатационной документации технического оборудования.
Обычно руководство по эксплуатации состоит из следующих основных разделов:
- Описание технического устройства и функции;
- Назначение и эксплуатация;
- Обслуживание устройства;
- Ремонт устройства;
- Правила хранения, перевозки и утилизации.
Это далеко не полный перечень разделов содержания руководства по эксплуатации. Паспорт может быть дополнен любыми необходимыми разделами, так как стиль оформления документа вполне свободный.
В руководстве по эксплуатации, согласно ГОСТу, следует применять глаголы в повелительном наклонении, например, «нажать», «включить», «взять», «повернуть» и т.п. Также нельзя забывать о логике действий пользователя. То есть, каждое действие, выполнить которое призывает документ, должно исходить из логики предыдущего.
При оформлении руководства по эксплуатации на особо сложное или опасное оборудование, следует особое внимание обратить на правила безопасности. В нужных точках всегда нужно приписывать такие предостерегающие слова, как «Осторожно!», «Внимание» и т.п. А для оборудования повышенной опасности на титульном листе руководства по эксплуатации нужно обязательно прописывать предостерегающую надпись.
Также важно приводить разного рода схемы, чертежи и рисунки, которые помогут пользователю лучше воспринимать текст документа.
Что касается технического оформления руководства по эксплуатации, информация об этом также прописана в ГОСТе 2.601-2019. В нём можно найти такие детали, как носитель документа, формат и качество бумаги, шрифт и размер, и многое другое.
Для быстрого и качественного выполнения разработки руководства или паспорта эксплуатации рекомендуем обратиться в наш центр. За плечами наших сотрудников десятки лет разработки технической документации – технических условий, обоснований безопасности, паспортов безопасности и много другого.
Бизнес-процессы организации иногда требуют создания руководящих документов, отличных от классических положений, регламентов, инструкций, правил или методических указаний. Директор, доведенный до бешенства хаосом в организации или отделе, может поручить вам составить документ с подробнейшим описанием порядка выполнения всех ключевых действий. В статье объясним, что такое руководство, в каких случаях его нужно создать и как именно это сделать.
Виды руководящих документов
При описании тех или иных процессов, действий и взаимодействий подразделений и работников, которые занимают определенные должности и исполняют ряд трудовых функций и обязанностей, часто используют такие виды руководящих документов, как положения, регламенты, инструкции, правила, методические указания. У каждого из перечисленных документов есть свое назначение (Таблица 1).
Что такое руководство и зачем оно нужно?
Кажется, что для нужд предприятия, документов, перечисленных в Таблице 1, достаточно. Но иногда требуется создать иной руководящий документ – руководство. Рассмотрим на конкретном примере, когда он может понадобиться.
Опишу ситуацию, которая однажды сложилась в нашей организации. Работники складов, имея на вооружении инструкции и правила, в которых описаны различные рабочие процессы (приемка товара по качеству и количеству, выдача товара покупателю, набор товара для отправки в региональные склады, работа с некондиционным товаром, работа с неликвидами, работа с вилочными погрузчиками и т.д.), часто ходили в грязной и рваной спецодежде (сменные комплекты чистой и целой одежды всегда есть) либо вообще не носили спецодежду, заменяя ее чем придется из домашнего гардероба, забывали своевременно освобождать помещение склада от использованной тары и упаковочных материалов, несколько раз забывали запирать склад на ночь.
Да, в организации действовали приказы, предписывающие носить на рабочих местах только выданную спецодежду установленного образца, менять ее еженедельно, а также правила сдачи и снятия помещения «на охрану». Но возникла надобность в едином документе, который объединил бы все уже расписанные действия сотрудников в единое целое буквально по шажочку. Что сделать вначале: отпереть дверь ключом или снять помещение с охранной сигнализации? Переодеть штаны или включить на складе свет? Как часто выбрасывать мятую упаковочную бумагу – после вскрытия каждой упаковки или после вскрытия десяти упаковок? Что делать, если покупатель, получающий товар, упал в обморок?
Думаю, понятно, что многие из заявленных «непоняток» были очень похожи на простой саботаж, которым иногда не брезгуют работники. Дескать, а где написано, что я должен сначала выдать товар покупателю, а уж потом подметать пол на складе? Я хочу сначала подмести, у меня и в инструкции написано: «удалить из помещения склада использованные упаковочные материалы и тару», и пусть весь мир подождет! Или что я должен сделать вначале: выключить освещение в помещении склада или пойти переодеваться?
И так может продолжаться бесконечно. Важно, что вопросы и надуманные нестыковки различных действий доводятся до абсурда и мешают производственному процессу.
После некоторого размышления в нашей организации было принято решение создать руководящий документ, который устранил бы все «непонятки», связал бы различные процессы, расставил бы акценты и приоритеты при выполнении различных действий. Кроме того, была поставлена задача написать этот документ как можно подробнее, что в устах доведенного до бешенства руководства звучало «как для дураков». Содержание и назначение документа не подпадало ни под одно определение руководящих документов, поэтому я назвала его «Руководство», так как формат руководства пользователя, прилагаемого, например, к приобретаемой бытовой технике, наиболее точно подходил к задаче.
Структура руководства для работников подразделения
Руководство для работников подразделения – это документ, описывающий работу подразделения в целом, который устанавливает и регулирует общий порядок работы по всем направлениям деятельности и включает в себя основные алгоритмы действий работников на протяжении рабочей смены, расставляет приоритеты выполнения различных процессов.
Структура руководства не регламентирована, но в целом имеет много общего со структурой других руководящих документов – положения, регламента (Схема 1).
Раздел «Общие положения»
Обычно в разделе «Общие положения» любого документа указываются:
1. Назначение (цель) документа.
2. Область применения.
3. Нормативные ссылки (или нормативные документы).
4. Связанные документы, локальные нормативные акты.
5. Глоссарий (термины и сокращения).
6. Порядок утверждения руководства, внесения в него изменений и его отмены.
Назначение (цель) документа
В написании этой части применяется стандартная фраза для всех руководящих документов подобного вида, например:
1.1. Настоящее руководство устанавливает и регулирует общий порядок работы персонала склада.
Также можно использовать такую формулировку:
1.1. Цель настоящего руководства – установление и регулирование общего порядка работы склада.
Область применения
В этом абзаце следует указать наименования и коды подразделений (если они есть), которых касается это руководство. Поскольку мы пишем документ для работников одного конкретного подразделения, то эту часть можно опустить. Но если руководство затрагивает и другие подразделения, то следует указать, какие именно. Например, так:
1.2. Область применения документа:
– складское хозяйство;
– транспортный отдел.
Нормативные ссылки (или нормативные документы)
Здесь необходимо указать нормативные документы, которые использовались при разработке этого руководства, а именно: действующие государственные, отраслевые стандарты, кодексы Российской Федерации, методические рекомендации по внедрению государственных стандартов, действующие приказы и постановления государственных органов и т.д.
Например, для создания руководства для работников склада эта часть может выглядеть следующим образом:
1.3. Нормативные документы:
1. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по количеству (утв. Постановлением Госарбитража СССР от 15.06.1965 № П-6).
2. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по качеству (утв. Постановлением Госарбитража СССР от 25.04.1966 № П-7).
Материал публикуется частично. Полностью его можно прочитать в журнале «Секретарь-референт» № 8, 2021.
Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение
Журавлев Денис
Что такое руководство пользователя и для чего его создавать
Ежедневно создаются новые продукты, программы, сервисы и часто пользователям приходится несладко при освоении какой-нибудь сложной программы, поэтому каждому новому продукту желательно собственное руководство. Для чего?
Большинство людей не хочет разбираться с чем-то незнакомым без персонального, всегда доступного и понятного помощника. А именно им и является хорошее руководство пользователя.
Общие советы по созданию пользовательской документации
Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.
После этого важно подумать о том:
- Где пользователь будет к нему обращаться: дома, на работе, в машине?
- Как часто он будет его просматривать?
- Насколько объективно сложен для понимания продукт?
Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.
Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?
Структура руководства пользователя
После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.
В первом разделе желательно рассказать общую информацию о программе:
- Для чего создан продукт.
- Какие задачи он решает.
- Какие основные выгоды от использования для клиента.
В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.
Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.
Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.
Иногда технические писатели забывают о важном моменте в руководстве пользователя — контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Инструменты для быстрого создания руководства пользователя
Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.
Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.
Видео-обзор основных возможностей программы Dr.Explain
Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.
Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.
При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.
У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.
Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.
Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.
Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.
Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.
Почему компании выбирают Dr.Explain для создания руководств пользователя
Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»
«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.
Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».
Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке
Наталья Обухова, бизнес-аналитик компании CRM Expert
«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.
Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.
Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.
Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».
Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны».
Прочитать полный кейс компании CRM Expert
Николай Вальковец, разработчик компании 2V
«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».
Прочитать кейс компании V2
Подытожим
Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.
Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/
Успешных вам разработок!
Смотрите также
- Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
- Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
Руководство — см. «Высшее руководство».
Руководство — см. «Высшееруководство».
3.8 руководство (Guide): Международный документ, не являющийся Международным Стандартом, опубликованный ISO или IEC, содержащий правила или рекомендации по международной стандартизации [3].
56. Руководство по методике определения фильтрационно-суффозионных свойств скальных оснований гидротехнических сооружений: П 28-74/ ВНИИГ им. Б.Е. Веденеева. — Л., 1975.
65. Руководство по полевой инженерно-геологической документации: П787-83 / Гидропроект. — М., 1984.
15. Руководство по определению прочности бетона в изделиях и конструкциях методом отрыва со скалыванием. М., 1977.
43. Руководство по полевым исследованиям сопротивления скальных оснований гидросооружений сдвигу. П. 01-73/ВНИИГ. Л., 1973.
32. Руководство по прогнозированию медико-биологических последствий гидротехнического строительства / Научный совет по проблемам биосферы АН СССР. М. 1990.
19. Руководство по наблюдениям за осадками и смешениями инженерных сооружений фотограмметрическими методами / Главное управление геодезии и картографии при Совете Министров СССР. М.: Недра, 1979.
6. Руководство по контролю прочности бетона в конструкциях приборами механического действия / НИИЖБ Госстроя СССР. — М.: Стройиздат, 1972.
5. Руководство по проектированию гидротехнических туннелей. М.: Стройиздат, 1982.
27. Руководство по определению состава и объема инженерно-геологических изысканий для гидротехнического строительства. П-651-74. — М.: Энергия, 1974.-110 с.
9. Руководство по испытаниям оросительных трубопроводов на прочность и герметичность (ВТР-С-6-76).-М.: Минводхоз СССР, 1976.
10. Нормокомплект для монтажа железобетонных труб со стальным сердечником/Минводхоз СССР. ВГПТИ «Союзоргтехводстрой», Волгоградский филиал Главволговодстроя/Проспект ВДНХ СССР.-Волгоград, 1980.
4. Руководство по интерпретации кривых ВЭЗ МДС/ПНИИИС Госстроя CCCР. — М.: Стройиздат, 1984. — 200 с.
4. Руководство по применению узлового метода проектирования, подготовки, организации и управления строительством сложных объектов и крупных промышленных комплексов/ ЦНИИОМТП. — М.: Стройиздат, 1982. — 36 с.
8. Руководство по расчету зданий и сооружений на действие ветра. — М.: Стройиздат, 1978. — 224 с.
22. Руководство по проектированию, строительству и эксплуатации заземлений в установках проводной связи и радиотрансляционных узлов. М., «Связь» 1971. 68 с.
9. Руководство по электрическим измерениям линий городских телефонных сетей. М.: Связь, 1976.
4. Руководство по проектированию бетонных и железобетонных конструкций гидротехнических сооружений. — М.: Стройиздат, 1983.
23. Руководство по проектированию плотин из грунтовых материалов, возводимых в северной строительно-климатической зоне: П 48-76/ВНИИГ. — Л., 1976.
6. Руководство по контролю прочности бетона в конструкциях приборами механического действия / НИИЖБ Госстроя СССР. — М.: Стройиздат, 1972.
19. Руководство по натурным наблюдениям за деформациями гидротехнических сооружений и их оснований геодезическими методами: П-648/Гидропроект.- М.: Энергия, 1980.
19. Руководство по наблюдениям за осадками и смещениями инженерных сооружений фотограмметрическими методами / Главное управление геодезии и картографии при Совете Министров СССР. М.: Недра, 1979.
29. Руководство по химическому анализу воды систем гидрозолоудаления ТЭС: П-67-97 / ВНИИГ. СПб, 1997.
6. Руководство по натурным наблюдениям за деформациями гидротехнических сооружений и их оснований геодезическими методами: title=»Руководство по натурным наблюдениям за деформациями гидротехнических сооружений и их оснований геодезическими методами»/Гидропроект. М.: Энергия, 1980.
5. Руководство по проектированию гидротехнических туннелей. М.: Стройиздат, 1982.
6. Руководство по составлению схем комплексного использования подземного пространства крупных и крупнейших городов. — М.: Стройиздат, 1978.
13. Руководство по разработке нормативов численности и типовых структур аппарата управления строительных организаций. М.: Стройиздат, 1980.
19. Руководство по гидрологическим расчетам при проектировании водохранилищ. — Л.: Гидрометеоиздат, 1983. — 283 с.
4. Руководство по применению прямоугольных светоаэрационных и зенитных фонарей в производственных зданиях/ЦНИИПромзданий Госстроя СССР.-М.: Стройиздат, 1981-31 с.
3. Руководство по проектированию и защите от коррозии подземных Металлических сооружений связи. — М.: Связь, 1978. — 217 с.
31. Руководство по определению коэффициента фильтрации водоносных пород методом опытной откачки. — М.: Энергоиздат, 1981. — 124 с.
14. Руководство по составлению схем комплексного использования подземного пространства крупных и крупнейших городов. — М.: Стройиздат, 1978, 76 с.
Смотри также родственные термины:
23.2 руководство по идентификации IG: Спецификация данных, содержащаяся всинтаксической структуре (определенной в ИСО/ТС 22745-30), которая применяет идентификаторы концепции из открытого технического словаря.
Примечание 1 — Руководство по идентификации обслуживается, как правило, организацией, получающей информацию (например, покупателем или группой покупателей).
Примечание 2 — На руководство по идентификации иногда делается ссылка как на «эталон свойств и правил».
Руководство по капитальному ремонту
Нормативно-технический документ, содержащий указания по организации и технологии ремонта , технические требования к составным частям изделия и изделию в целом при дефектации, ремонте и контроле после капитального ремонта
title=»Руководящий нормативный документ. Правила организации технического обслуживания и ремонта зданий и сооружений электростанций и сетей»-84
3.7.4 руководство по качеству (quality manual): Документ (3.7.2), определяющий систему менеджмента качества (3.2.3) организации (3.3.1).
Примечание — Руководства по качеству могут различаться по детальности изложения и форме, исходя из размера и сложности конкретной организации.
Руководство по качеству — документ, определяющий систему менеджмента качества организации (п. 3.7.4 ГОСТ Р ИСО 9000-2001).
Руководство по качеству — документ, определяющий систему менеджмента качества организации (п. 3.7.4ГОСТ Р ИСО 9000-2008).
22 Руководство по качеству
Документ, излагающий политику в области качества, определяющий структуру системы качества организации и описывающий ее элементы
title=»Управление качеством и обеспечение качества — Словарь», 3.12
3.7.4 руководство по качеству (en quality manual; fr manuеl qualité): Документ (3.7.2), определяющий систему менеджмента качества (3.2.3) организации (3.3.1).
Примечание — Руководства по качеству могут различаться по форме и детальности изложения, исходя из соответствия размеру и сложности организации.
Руководство по качеству — документ, устанавливающий цели, методы и процедуры, позволяющие метрологической службе решать задачи, определяемые Положением о метрологической службе.
3.7.4 руководство по качеству (quality manual): Документ (3.7.2), определяющий систему менеджмента качества (3.2.3) организации (3.3.1).
Примечание — Руководства по качеству могут различаться по детальности изложения и форме, исходя из размера и сложности конкретной организации.
Руководство по качеству — документ, излагающий политику в области качества и описывающий Систему качества организации.
3.2.53 руководство по качеству (quality manual): Документ, определяющий систему менеджмента качества организации.
1.5. Руководство по качеству организации и выполнения калибровочных работ (далее — «Руководство по качеству») — документ, устанавливающий цели, методы и процедуры, позволяющие метрологической службе или калибровочной лаборатории решать задачи, определяемые положением о них.
Руководство по охране труда — документ, определяющий СУОТ организации.
Руководство по охране труда — документ, определяющий систему управления охраны труда организации.
3.52 руководство по привязке (tailoring guideline): Инструкции, которые позволяют организации приспособить описание стандартных процессов оценки применительно к имеющимся конкретным потребностям.
Примечания
1 Привязка процессов оценки приспосабливает описание процесса для конкретной цели. Например, проект создает свой определенный процесс путем привязки набора стандартных процессов организации для удовлетворения целям, ограничениям и среде проекта.
2 Набор стандартных процессов организации описан на общем уровне, который может оказаться неприменимым непосредственно для осуществления процесса.
3 Руководства по привязке предназначены для тех, кто устанавливает определенные процессы для конкретных нужд.
4 Руководства по привязке описывают, что может и что не может быть изменено, и идентифицируют компоненты процесса оценки, которые подлежат изменениям.
5.42 руководство по утилизации отходов: Нормативно-методический документ, регламентирующий цель, задачи, организацию, порядок и правила поведения, критерии ресурсосбережения, а также меры по обеспечению безопасности и охраны окружающей среды при утилизации отходов конкретного вида.
3.24 руководство по эксплуатации; РЭ: Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частях и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей.
[ГОСТ 2.601-2006, пункт 5.1.2, таблица 1]
3.17 руководство по эксплуатации: Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частей и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей.
3.18 руководство по эксплуатации: Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частей, а также указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, ремонта, хранения и транспортирования), оценки технического состояния для определения необходимости выполнения ремонта, сведения по утилизации изделия и его составных частей.
22 руководство по эксплуатации средства связи: Нормативный документ, содержащий все сведения, необходимые для правильной и безопасной эксплуатации средства связи, включая его технические характеристики, устройство и принцип работы, правила обращения при хранении, транспортировке, подготовке к работе и использовании по прямому назначению (ГОСТ 2.601)
7. Руководство проектами в условиях рынка. Пособие (зарубежный опыт). Совместное советско-британское предприятие «Сети». — М., 1991.
Словарь-справочник терминов нормативно-технической документации.
.
2015.
Чтобы объяснить человеку как выполнять задачу или работать с инструментом, нужно составить понятную инструкцию. Неизвестная компьютерная программа или новые функции на работе – все это требует разъяснений для успешного взаимодействия. В статье рассмотрим, как правильно написать инструкцию.
Инструкция – это документ, который объясняет способы или правила выполнения определенных действий. А понятная инструкция делает то же самое, но простым языком. Многие руководства написаны очень сложно и люди предпочитают не заглядывать в них, пока что-то не сломается.
Однако такой подход может привести к не самым лучшим последствиям. Например, работник не изучил правила по работе на буровой установке или неверно понял описанный материал, и получил травму из-за неправильного использования техники. Поэтому важно ответственно подойти к составлению и разобраться, как правильно написать инструкцию.
3 основных вида инструкций
Есть несколько типов инструкций. Они предназначены для разных целей, но разрабатываются по схожим принципам. К примеру – уяснив, как написать инструкцию по работе системного администратора, вы легко сможете применить эти знания и при подготовке руководства по использованию мини-АТС.
Пошаговая инструкция
Такие руководства позволяют регламентировать все возможные повторяющиеся процессы. Поставленная задача разбивается на несколько этапов, и каждый этап дополняется пояснениями. Примеры таких инструкций – пошаговые алгоритмы составления бухгалтерской отчетности, подключение к удаленному рабочему столу или действия при пожаре.
Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:
- Откройте верхнюю крышку и извлеките блок фотобарабана
- Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
- Вытащите тонер-картридж
- Поставьте на его место новый
- Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
- Установите фотобарабан обратно в принтер
- Закройте крышку
- Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает – обратитесь к системному администратору
Инструкция по использованию
Это перечень рекомендаций по правильному использованию приборов, например, руководство к сканеру штрих-кодов. Такие мануалы будут полезны пользователям непростых устройств — на рабочем месте или в быту.
В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:
- В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic – 160-180°C.
- Максимальное время работы ламинатора – 4 часа. Затем нужно сделать получасовой перерыв.
- Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его.
- Внимание! Не ламинируйте влажные образцы – жидкость может повредить электронные компоненты!
- После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством.
- Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию!
Должностная инструкция
Так называют документ, регулирующий сферу обязанностей для конкретной должности. Также здесь определены права работника, требования к квалификации, область ответственности и формы премирования. Должностные инструкции могут быть составлены для любого сотрудника – от уборщицы до генерального директора. Их готовят совместно с юристом.
Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:
- Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
- При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
- Бригадир раздает списки, по которым комплектуются грузы.
- Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
- Если есть необходимость, грузчик может привлекаться к другим работам на территории склада – уборке, контролю за въездом транспорта и пр.
Должностная инструкция – это скорее юридический документ, чем пользовательский. А чтобы понятным языком проинструктировать сотрудника по его работе, обычно составляют отдельное обучение – «Пособие по должности». В нем подробно рассказывают о роли и ценном конечном продукте, описывают систему мотивации, метрики и алгоритмы выполнения работы. И размещают эти материалы на платформе для онлайн-обучения.
Ниже вы можете получить готовую структуру обучения для курса «Пособие по должности».
Общие правила при подготовке инструкций
Для подготовки любого типа руководств используются одни и те же приемы работы с информацией. Вот рекомендации, которые подскажут как написать хорошую инструкцию:
- Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
- Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
- Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
- Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
Как структурировать много данных → - Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта
Алгоритм разработки руководства: 9 шагов
Рассмотрим, как написать доступную инструкцию для сотрудников на примере описания алгоритма действий. Особенность этого руководства в том, что для него нужно не только перечислить отдельные действия, а установить их в правильной последовательности, чтобы привести читателя к нужному результату. В общем случае необходимо:
- Собрать информацию
- Сгруппировать ее по отдельным этапам
- Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя
В качестве примера возьмем ситуацию, когда организация перешла на электронный документооборот. При этом часть сотрудников не умеет работать с программой Microsoft Word и нужно объяснить им, как подготовить заявление о выдаче спецодежды.
Шаг 1. Изучить ситуацию
Конечно, вы не один год используете Word и легко можете подготовить требуемое заявление. Но в данном случае нужно взглянуть на проблему глазами пользователя – человека, который впервые сталкивается с этой программой. Поэтому нужно не опираться на текущие знания по работе в Word, а самостоятельно проделать весь путь заново. С большой вероятностью вы откроете для себя что-то новое – ведь раньше многие операции выполнялись автоматически. Сходу очень трудно вспомнить, как называлась «та кнопка для создания списка» и другие детали.
Шаг 2. Разложить все на отдельные этапы
Задача этого шага – создать предварительный план решения задачи. Такой алгоритм начинается с исходной ситуации и заканчивается достижением результата. В начало каждого пункта поставьте глагол, определяющий ключевое действие этого шага:
- Запустить программу Microsoft Word
- Создать новый документ
- Набрать необходимый текст
- Отформатировать его
- Сохранить файл
- Сообщить в бухгалтерию, что заявление подготовлено
Шаг 3. Описать каждый этап
Здесь нужно конкретизировать каждый шаг, необходимый для достижения поставленной цели. При этом не усложняйте описание. Если действие можно выполнить несколькими способами, опишите только один вариант, максимум два – тогда читатель с меньшей вероятностью запутается.
Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:
2. Нажмите на раздел «Новый документ» в правой части экрана
Если руководство предназначено для новичков, избегайте профессиональной лексики. В нашем примере лучше обойтись без понятий «Интерфейс» и «Строка состояния». Важно понимать, что вы пишете не теоретический учебник для передачи системных знаний, а практическое руководство, по которому человек сможет здесь и сейчас выполнить действия и достичь результата. Если не обойтись без терминов и аббревиатур, поясните их.
Совет. Старайтесь не нагромождать вашу инструкцию ненужными действиями. Например, лишней будет информация о том, какой шрифт использовать для заявления – в большинстве случаев пользователь столкнется с шаблоном Normal, где стоит подходящий Calibri размером 11 пунктов.
Шаг 4. Рассмотреть нестандартные варианты развития ситуации
Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:
3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры
Шаг 5. Подобрать изображения и привести примеры
Если можно проиллюстрировать какую-то операцию – обязательно сделайте это. Для рецептов блюд подойдут снимки каждого шага, а для инструкций по сборке – взрыв-схемы (эскизы, на которых вся конструкция разобрана на детали и они разнесены в разные стороны). А чтобы наглядно показать работу в компьютерной программе, следует подготовить скринкасты или скриншоты с пояснениями.
Шаг 6. Придумать заголовок
Даже если вы написали руководство для внутреннего пользования, а не для публикации в интернете, яркий заголовок привлечет внимание и настроит на выполнение нужной работы. Вот несколько вариантов для нашего примера:
- «Как написать инструкцию по подготовке заявления»
- «6 шагов для подготовки электронного документа»
- «Простой способ написать заявление на компьютере»
- «Подробный алгоритм подготовки документа для безбумажного оборота»
Шаг 7. Оценить промежуточный вариант
В результате должен получиться подобный текст:
Как написать простую инструкцию (образец):
- Запустите программу Microsoft Word
- Нажмите на раздел «Новый документ» в правой части экрана
- Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
- Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»
- Сохраните файл. Для этого:
- Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
- Выберите путь сохранения файла
- В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
- Нажмите кнопку «Сохранить»
- Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено.
Пример объявления, на который можете ориентироваться при подготовке:
Шаг 8. Тестирование
Внимательно проверьте инструкцию на логические ошибки. Желательно, чтобы коллеги или знакомые взглянули на нее со стороны. Еще лучше – когда неопытный человек изучает составленный алгоритм и пытается с его помощью добиться желаемого результата.
Проверьте алгоритм с помощью этих вопросов:
- Понятен ли указанный порядок действий? Да, мы улучшали его в шагах 2-5
- Все ли нюансы учтены? Да, последовательность шагов охватывает всю необходимую процедуру
- Есть ли в алгоритме сложные этапы, которые можно разбить на несколько частей? Нет, все они были скорректированы на предыдущих шагах
- Достигнут ли результат? Будет ли он неизменным при разных условиях использования алгоритма? Да, на выходе мы получаем файл для безбумажного оборота. При правильном следовании приведенной последовательности, результата можно достичь вне зависимости от того, кто составляет заявление – грузчик или уборщица
Шаг 9. Обучить сотрудников по инструкции
Если руководство предназначено для сотрудников компании, важно проконтролировать, что они изучили ее. Для этого загрузите инструкцию для персонала на платформу Unicraft, назначьте на нее работника и отслеживайте его прогресс.
Особенности такого обучения:
- Информация сопровождается рисунками, схемами, анимацией, формами обратной связи – это увлекательнее, чем простое чтение текста
- В режиме реального времени руководитель может видеть, какое количество материала уже изучено
- В конце разделов и всего курса предусмотрены контрольные вопросы. Процент правильных ответов для успешного прохождения курса можно задавать самостоятельно (обычно он составляет 80%)
Примеры готовых инструкций
Ниже приведены примеры инструкций по пользованию платформой Unicraft. Нажмите на изображение, чтобы перейти на страницу с руководством.
Вывод
Резюмируя все изложенное, можно составить требования к идеальной инструкции:
- Актуальность. В тексте нет устаревших сведений
- Информативность и целостность. Подготовленное руководство содержит все необходимые сведения
по обозначенной теме. У пользователя не остается вопросов - Лаконичность. Приоритеты для составителя – это точность формулировок и отсутствие второстепенных сведений. Часто бывает, что инструкцию смотрят в сложных ситуациях, когда нужно быстро получить ответ на возникший вопрос
- Наглядность. Информация сопровождается примерами и иллюстрациями
- Конкретный результат. Руководство помогает получить конечное решение
- Соотносимость с текущими знаниями пользователя. Чем ниже уровень знаний аудитории, тем подробнее объяснения
- В тексте нет сложных конструкций. Они разбиты на несколько частей. Каждый пункт списка – это отдельное действие, которое дополняется комментариями и пояснениями
Вам будет интересно
Готовые курсы для бизнеса: проверенные агрегаторы онлайн курсов
Как учиться эффективно: проверенная технология обучения
Где провести вебинар: лучшие программы для вебинаров
Перейти на главную блога
Содержание
- Что такое руководство:
- Руководство по организации
- Руководство по процедурам
- Руководство по качеству
- Приветственное руководство
- Руководство пользователя
Что такое руководство:
Руководство — это книга или брошюра, в которой собраны основные, важные аспекты предмета. Таким образом, руководства позволяют нам лучше понять, как что-то работает, или получить упорядоченный и краткий доступ к знаниям по теме или предмету.
Есть, например, пособия для изучения математики, литературы, истории или географии. Существуют также технические руководства, которые позволяют понять принцип работы различных электронных устройств или устройств.
Таким же образом существуют руководства, используемые для описания и объяснения деятельности компании или организации (руководство по процедурам, организации, качеству и т. Д.), А также другие типы руководств, также относящиеся к организационной области, такие как руководства, фирменный стиль, сосуществование или административные, среди прочего.
Слово руководство также работает как прилагательное для обозначения то, что поддается управлению или выполняется руками, который требует умения обращаться с руками или который, помимо прочего, легко сделать или понять.
Слово как таковое происходит от латинского мануалис, что означает «то, что можно взять в руки» или «то, что можно носить в руке».
Руководство по организации
Организационное руководство — это документ, в котором устанавливаются и уточняются функции персонала, составляющего организационную структуру компании. В этом смысле руководство организации содержит четкое и подробное описание структуры и подразделений, из которых состоит организация, и всего, что связано с их обязанностями, задачами, полномочиями, полномочиями и функциями. Целью организационного руководства является обеспечение адекватного функционального соответствия между различными позициями организационной структуры и их задачами, обязанностями и полномочиями.
Руководство по процедурам
Руководство по процедурам — это документ, содержащий описание действий, которым должна следовать компания для выполнения своих общих задач и выполнения своих функций. Он включает подробные и описательные аспекты, начиная от последовательного порядка действий до последовательности задач, необходимых для выполнения работы. Таким же образом он включает практические аспекты, такие как использование ресурсов (материальных, технологических, финансовых), и методологические, такие как применение более эффективных и действенных методов работы и контроля. Руководства по процедурам также помогают при вводе в должность нового персонала, описывают деятельность каждой должности, объясняют отношения с другими связанными областями, позволяют надлежащую координацию деятельности между различными отделами и т. Д. Короче говоря, они предоставляют обзор компании, ее деятельности и функций.
Руководство по качеству
Руководство по качеству — это документ, в котором компании четко и ясно излагают набор процедур, которых они придерживаются для достижения определенных стандартов качества, путем принятия руководящих принципов, установленных в Системе управления качеством (СМК). В нем объясняются механизмы контроля и цели в области качества, которые, как правило, преследует компания. Стандарты качества, с другой стороны, должны соответствовать процедурам и требованиям, требуемым стандартом ISO 9001, разработанным Международной организацией по стандартизации, который датируется 2008 годом и направлен на упорядочение этого аспекта.
Приветственное руководство
Приветственное руководство, также называемое вводным руководством, представляет собой документ, с помощью которого компания сообщает работнику всю необходимую информацию, касающуюся компании: ее историю, цель, ценности, миссию и видение, характеристики, которые отличают ее от других аналогичных компаний. , продукты или услуги, которые он производит или продает. Кроме того, он предоставляет другую важную информацию, такую как организационная структура компании, функции каждой должности и контакты других отделов. Он должен быть написан простым, ясным и понятным языком, поскольку вся содержащаяся в нем информация, такая как политика занятости, предотвращение рисков и рекомендации по поведению, имеет договорную ценность.
Руководство пользователя
В качестве руководства пользователя известна книга или брошюра, содержащая набор информации, инструкций и предупреждений, связанных с использованием определенного продукта или услуги. Он использует простой язык и использует тексты, изображения, диаграммы и диаграммы. В них подробно описаны функции и доступные опции устройства.Руководства пользователя распространены, особенно в электрических или электронных устройствах, таких как сотовые телефоны, планшеты, микроволновые печи, телевизоры и т. Д.
Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). Очевидно ли это?
Назначение руководства пользователя
Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике.
Состав типового руководства пользователя
Конкретный подход к написанию определяется многими факторами:
– назначением программы и областью ее применения;
– сложностью программы;
– количеством разнообразных вариантов использования.
Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов:
– Введение, где указывают область применения ПО, краткое описывают его возможности, требуемый уровень знаний пользователя и список документов, которые необходимо изучить помимо настоящего руководства;
– Назначение и условия применения, где описывают виды деятельности и функции, которые автоматизированы и условия, при соблюдении которых автоматизация используется;
– Подготовка к работе, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности;
– Описание операций, представляет собой основной раздел, где описывают функции программы, процессы работы с данными, выполнение конкретных задач пользователя;
– Аварийные ситуации, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.;
– Рекомендации по освоению, где приводят методические рекомендации по изучению программы и примеры использования.
Данная структура может меняться и дополняться – например, основной раздел часто разбивают на несколько значимых разделов по группам функций или задач, также в современных системах нередко добавляют раздел Интерфейс пользователя, где описывают взаимодействие пользователя с программой с примерами и снимками экрана.
Стандарты для руководства пользователя
Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения.
Заключение
Грамотно написанное Руководство пользователя может сэкономить значительное количество времени на обучение и адаптацию пользователя к программе, а также снизить количество ошибок в работе что, в свою очередь, повышает экономическую эффективность системы. Если вы не хотите вникать во все тонкости создания Руководства пользователя, но хотите иметь полный, качественный и полезный документ – обратитесь в компанию ТехРайтКонсалт, и мы применим весь наш опыт и знания для решения вашей задачи по доступной цене!
– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства оператора.