Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

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

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

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

1. Стандарты

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

• IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
• ГОСТ 19:
  • ГОСТ 19.402-78 ЕСПД. Описание программы;
  • ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

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

2. Структура

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

Хорошее руководство пользователя должно содержать:

• Аннотацию , в которой приводится краткое изложение содержимого документа и его назначение. Также рекомендуется писать краткую аннотацию в начале каждого крупного раздела.
• Введение , содержащее информацию о том, как лучше всего использовать данное руководство
• Содержание
• Главы , описывающие, как использовать ПО
• Глоссарий и
• Предметный указатель

Также руководство пользователя может содержать:

• FAQ и ответы на них
• Ссылки на дополнительную информацию по системе
• Раздел , описывающий возможные проблемы и пути их решения

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

3. Пользователи

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

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

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

4. Особенности изложения

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

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

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо : In File menu, select Save item .
Хуже : Select Save item from File menu.

4.2 Используйте повелительное наклонение , не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо : Click Logout .

Хуже : It is needed to click Logout to log out current user account from the system.

Хуже : If user wants to log out current user account from the system(s)he needs to click Logout.

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

Хорошо:
To create project :

1. Click the Create button on toolbar.
2. On the Create Project overlay fill in all mandatory fields.
3. Click the Save button to save the project.

Хуже : To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время . Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо : When user clicks the Start button, the program starts the process.

Хуже : When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон .

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

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

5. Внешний вид

5.1 Продумайте стиль документа . Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

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

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

6. Поддержка

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

Заключение

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

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

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

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

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

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

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

Разработка инструкции

Инструкции по охране труда разрабатывается не для конкретного работника, а для профессий, должностей или видов выполняемых работ. Например, "Инструкция по охране труда для слесаря-ремонтника", "Инструкция по охране труда при работе на высоте" и т.д.

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

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

• Типовые инструкции по охране труда;
• представленные на нашем сайте.

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

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

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

Разделы инструкции

Инструкция по охране труда должна включать следующие разделы:

1. Общие требования охраны труда . Как правила это раздел включает:

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

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

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

3. Требования охраны труда во время работы . В данном разделе рекомендуется указать:

• Приемы и способы безопасного производства работ;
• Указание о содержание рабочего места в течение рабочего дня.

4. Требования охраны труда в аварийных ситуациях . Здесь следует указать:

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

5. Требования охраны труда по окончании работы . Тут можно указать:

• Порядок остановки оборудования;
• Порядок уборки рабочего места и отходов;
• Порядок уведомления ответственных лиц о обнаруженных недостатках;
• Требования к личной гигиене.

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

Примечание: Для работников опасных производственных объектов правилами безопасности предусматривается разработка производственных инструкций. Такие инструкции целесообразно объединять с инструкциями по охране труда. Например, “Инструкция по охране труда и производственная для машиниста башенного крана”.

Утверждение и хранение инструкций

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

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

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

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

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

Все работники, инструктируемые по инструкции должны быть ознакомленные с ней под роспись.

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

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

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

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

• При внедрение новых технологий и оборудования;
• По результату или аварий;
• По требованию инспектора ГИТ.

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

Статьи-инструкции… Их любят и читатели, и заказчики, и веб-авторы.

Нам заказали серию статей-инструкций!

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

Правда, есть один минус.

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

Тогда начинаем…в формате инструкции, конечно. 🙂

Шаг №1 С чего начать написание статьи-инструкции для сайта

Конечно, с теории. Прежде чем писать, нужно понять, как это делать. Вы ведь помните, что правильные фрирайтеры пишут правильные статьи? 🙂

Правила написания статьи-инструкции:

1. Статья должна быть полезной

Главное в статьях - польза!

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

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

Но это совсем не значит, что можно писать инструкции без акцентов и списков.

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

А чтобы польза была →

2. Инструкция должна быть подробной

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

Отсюда вывод→

3. Инструкция должна быть экспертной

Как измерить удава - задача для эксперта

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

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

Поэтому еще одно правило написания статьи →

4. Инструкция должна быть наглядной

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

Не забывайте про списки и подзаголовки.

Как это, забыли про списки и картинки?

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

Шаг №2 Определяем круг тем для написания статей-инструкций

Сложно найти темы, которые НЕ подходят для этого вида статей.

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

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

Что делать, если вы «не в теме»?

Вариантов всего три:

• выбирать для написания статей темы, в которых разбираетесь

Например, если вы мама, которая решила найти достойный заработок в декрете - пишите на детскую тематику или выберите то, что вам интересно: ваши увлечения, профессия до декрета и т.д.

• писать на основе опыта заказчика

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

• приобрести нужный опыт

Не будем писать на незнакомые темы

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

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

Шаг№3 Выбираем вид статьи-инструкции

Удивлены? Озадачены? Да, видов инструкций несколько, а точнее четыре:

• простая пошаговая инструкция
• инструкция-практикум
• инструкция с предварительной постановкой проблемы
• инструкция-перевертыш

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

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

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

Инструкция-практикум

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

К примеру: «Как сшить маскарадный костюм для девочки» или «Как научиться ставить цели».

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

Я еще не закончил говорить о проблеме

Если тема для вашей аудитории новая , то стоит уделить особое внимание постановке проблемы: до 30-50% всего текста.

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

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

Инструкция-перевертыш

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

Например, «10 ошибок фрилансера-новичка» или «5 основных причин крушения семей в России».

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

Шаг №4 Составляем план написания статьи-инструкции

К сожалению или к счастью, хорошую статью без плана не напишешь.

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

А как же план, извините, пожалуйста?

• Начните с цели статьи

Что вы хотите рассказать читателям? Какую проблему решить? Что посетители сайта должны сделать ПОСЛЕ прочтения?

• Теперь приступайте к заголовку

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

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

Если вы даете в статье ответ на вопрос, то вопросительный знак в заголовке НЕ ставится.

Еще один вариант - использование цифр : «12 шагов для успешной сдачи экзамена» или «5 этапов подготовки к идеальной свадьбе».

• Теперь очередь лида

Очертите проблему, зацепите читателя, заинтригуйте, подарите надежду.

Читатель должен понять, что эта статья для него и он найдет ответ на свой вопрос.

• Основная часть инструкции

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

Если вы решили написать статью с постановкой проблемы - тщательно рассмотрите проблему со всех сторон.

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

• Подытожьте

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

Шаг № 5 пишем инструкцию

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

Всё, ваша инструкция готова.

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

Где отработать технику написания статей для сайтов?

Просто ли писать инструкции? Это зависит от практики. Чем больше практики, тем проще писать статьи.

Но как практиковаться, если не умеешь писать статьи? Под контролем опытных тренеров на статейном марафоне .

Тренироваться нужно под присмотром!

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

Такие заказчики заинтересованы в долгосрочном сотрудничестве, так что возможно вы найдете себе клиентов надолго.

Готовы практиковаться на реальных клиентах под присмотром четырех успешных экспертов? Тогда добро пожаловать на статейный марафон!

А пока расскажите, умеете ли вы писать статьи-инструкции? Все ли виды инструкций вам приходилось писать? Какие фишки вы используете при написании статей-инструкций для сайтов?

Получите удобный инструмент оценки качества статьи

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

Вам понадобится

типовые инструкции

требования техники безопасности

Инструкция

1 Составьте вводную часть производственной инструкции. Здесь отразите область распространения и назначение документа.

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

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

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

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

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

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

ПОЛОЖЕНИЕ

О разработке Производственных инструкций

Введение

Настоящее Положение разработано на основании требований Единой системы технологической документации (ЕСТД), ЕКТС, ГОСТ 12.0.004 и с учетом письма Федеральной службы по труду и занятости от 24 ноября 2008 г. N 6234-ТЗ« О должностных и рабочих инструкциях» и определяет порядок разработки, утверждения и применения производственных инструкций для рабочих профессий ООО «» (далее – организация).

Общие положения

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

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

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

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

1.4. Значение производственной инструкции как организационного документа заключается в следующем:

Закрепляет правовой статус и место работника в системе управления;

Определяет задачи, функции, права и обязанности работника;

Позволяет обоснованно оценить результаты деятельности;

Является правовой основой для аттестации работника, определения его дисциплинарной и материальной ответственности;

Устанавливает организационные основы правовой деятельности.

1.5. Производственные инструкции пересматриваются один раз в 5 лет.

1.6. Срок хранения производственных инструкций в Организации составляет 45 лет после их замены.

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

2. Порядок разработки и оформления Производственных инструкций

2.1. Производственные инструкции разрабатываются на основании штатного расписания организации, Общероссийского классификатора профессий рабочих, должностей служащих и тарифных разрядов ОК 016-94 (ОКПДТР), инструкций по эксплуатации заводов-изготовителей на оборудование, инструменты и приспособления, применяемых на рабочем месте рабочего конкретной профессии руководителем структурного подразделения, в чьем подчинении находится рабочее место.

2.2. Перед разработкой производственных инструкций необходимо провести:

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

Определение безопасных методов и приемов работ, их последовательности, а также

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

Определение соответствия требованиям безопасности применяемого оборудования,

приспособлений и инструмента;

Изучение конструктивных особенностей и эффективности средств защиты, которые

могут быть использованы при выполнении соответствующих работ.

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

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

2.5. Производственные инструкции для рабочих не должны содержать каких-либо ссылок на другие нормативные и нормативно-технические документы (кроме ссылок на другие инструкции для работников). Основные требования этих документов должны быть учтены разработчиками инструкции. При необходимости требования этих документов следует привести в инструкции.

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

Замена слов в тексте инструкции буквенными сокращениями (аббревиатурой) допускается при условии полной расшифровки аббревиатуры при ее первом применении.

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

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

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

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

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

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

2.11. Текст инструкции следует разделить на разделы (при необходимости и на подразделы) и пункты и пронумеровать арабскими цифрами: разделы – в пределах инструкции, подразделы – в пределах раздела, пункты в пределах подразделов (при их отсутствии – в пределах разделов).

Так как «Введение» не несет в себе инструктивных указаний, то внутри его можно нумерацию не проводить.

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

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

Например: ПИ 01.01-2012 – Производственная инструкция для ________ (наименование профессии )

2.14. Оформление Производственных инструкций должно быть выполнено по форме, приведенной в Приложении 1

3.2. Примерное содержание разделов Производственной инструкции:

Введение

1. Общие положения

2. Характеристика работ

4. Ответственность

5. Описание рабочего места и видов эксплуатируемого оборудования

6. Описание порядка эксплуатации оборудования, механизмов, инструмента и приспособлений.

6.1. Определение и назначение

6.2. Техническая характеристика

6.3. Описание производственного процесса

6.4. Условия ведения производственного процесса и (или) эксплуатации оборудования, механизмов, инструмента и приспособлений

6.5. Подготовка к ремонту

6.6. Текущее обслуживание

6.7. Производственные неполадки и методы их устранения

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

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

3.3. В Разделе «Введение»

3.4. В разделе «Общие положения» должны быть отражены:

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

В чьем непосредственном подчинении находится работник (дополнительно кому подчиняется на период отсутствия вышестоящего лица);

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

Как организуется работа – самостоятельно работником, в соответствии с планом работы структурного подразделения или по утвержденному директором Организации гибкому или иному графику работы;

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

Чьи устные и письменные распоряжения выполняет работник – дополнительно к распоряжениям непосредственного руководителя или в его отсутствие;

Квалификационные требования к образованию, стажу работы – разрабатываются на основании ЕКТС;

Что должен знать работник.

3.5. В Разделах «Характеристика работ», «Права», «Ответственность» должны быть отражены требования определенные ЕКТС по данной профессии и дополнительно прописаны конкретные виды работ определенные работодателем не входящие в ЕКТС, но необходимые для осуществления производственной деятельности подразделения организации (совмещение профессий, специальные виды работ, требующих дополнительное обучение и т.п.).

3.6. В Разделе «Описание рабочего места и видов эксплуатируемого оборудования»

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

3.7. В Разделе «Описание порядка эксплуатации оборудования, механизмов, инструмента и приспособлений»

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

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

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

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

Условия ведения производственного процесса и (или) эксплуатации оборудования, механизмов, инструмента и приспособлений определяются требованиями Руководств или Инструкций по эксплуатации оборудования, механизмов, инструмента и приспособлений заводов-изготовителей, Правил устройства и безопасной эксплуатации и конкретными условиями эксплуатации определенными организацией;

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

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

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

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

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

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

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

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

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

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

Как сделать сервис более понятным

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

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

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

О чем спрашивают начинающие пользователи

Новые пользователи задают два вопроса:

1. С чего начать, чтобы пользоваться сервисом? (пользователь плохо понимает сервис) .
2. Как выполнить ту или иную задачу? (не понимает последовательности действий, сценария работы) .

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

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

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

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

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

Мы адаптировали эти советы.

Хорошая справочная статья	Плохая справочная статья
Содержит четкие описания шагов, которые приведут пользователя к цели	Предлагает пользователю самостоятельно определить проблему и выбрать решение из списка
Предлагает инструкции для решения только текущей задачи Нажмите «ОК» и ваше письмо уйдет адресату	Содержит список советов, относящихся к данному этапу работы с системой: Чтобы написать письмо - нажмите «Создать» Чтобы удалить письмо - нажмите «В Корзину» Чтобы отправить письмо - нажмите «ОК»
Размещена на видном месте, появляется, если пользователь зашел на сайт и 10 секунд не выполняет никаких действий	Спрятана в разделе «Помощь по сайту», который никто не читает
Умещается в нескольких предложениях	Содержит много страниц и ссылок

Правила американского юзабилиста дополняет российский специалист, автор книги “Shareware: профессиональная разработка и продвижение программ” Станислав Жарков:

“При описании пути решения проблемы, как и при написании любой документации, нужно избегать составления слишком объемных текстов, т. к. пользователи будут просто пробегать их глазами, не вникая в смысл написанного, подобно тому, как человек, просматривающий газету, сначала останавливает взгляд на коротких заметках, пропуская большие материалы. Лучше всего составить что-то наподобие пошаговой инструкции, каждый шаг из которой составляет 1—2 предложения” (“Shareware: профессиональная разработка и продвижение программ”, СПб., 2001).

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

Создаем инструкции с помощью подсказок

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

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

А это пример подсказки для пользователей Google Plus .

Краткие инструкции в подсказках обращают внимание пользователей на новые или дополнительные функции. Система автоматически показывает их новым пользователям в начале работы. Они отображаются лишь один раз, их можно закрыть (пропустить), либо перейти в справочный раздел ресурса и прочитать больше. Чтобы объяснить последовательность действий, разработчики сервисов объединяют такие подсказки в демо-туры. Подобные инструкции предлагают своим пользователям Google Plus и Youtube.

Чек-лист для разработки эффективной инструкции в форме подсказок

1. Опишите подсказками конкретные шаги пользователей.

2. Создайте обучающие туры для сценариев работы.

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

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

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

6. Разрешите пользователю включать демо-туры в любой момент.

7. Оформите подсказки в едином для сервиса дизайне.

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

Для создания одностраничных инструкций (для одного окна интерфейса) подходят готовые библиотеки кода Java Script: Intro.js и Bootstro.js . Для создания кросс-страничных подсказок подойдут сервисы Hintarea и Walkme.com .

Подсказки могут помочь тем, кто:

• установил новое мобильное приложение;
• воспользовался онлайн-сервисом (системой бронирования, доской объявлений);
• оформляет заказ в интернет-магазине;
• работает с бизнес-приложением (CMS, CRM).

Пример: подсказки для обучения пользователей CMS Wordpress

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

• с чего начать работу;
• что означают названия и термины;
• где найти справочную информацию;

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

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

Объясним пользователю, с чего начинать

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

Научим правильно заполнять формы

Обратим внимание на важные функции

Формируем понимание работы с контентом

Объясним специальные термины

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

Еще раз о пользе

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

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

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

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

Это перевод статьи, ранее опубликованной в американском журнале для интернет-предпринимателей sandhill.com.

Специально для онлайн-издания “ПроГрабли” материал значительно расширен, главным образом за счет включения информации по аспектам UX-дизайна при разработке веб-продукта.