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

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

Компания Серконс оказывает услуги в сфере разработки руководства по эксплуатации

Зачем и для кого создается документ?

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

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

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

Особенности создания и оформления

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

Руководство может создаваться на подготовительном этапе, как на отдельный продукт, так и на группу однотипных моделей с едиными данными и правилами. Процесс его оформления не отличается от конструкторско-технической документации и регулируется положениями национальных стандартов ГOCТ 2.601-2013 и ГOCТ 2.105-95.

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

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

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

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

Требования к созданию руководства по эксплуатации

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

• ГОСТ 2.610-2013;
• ГОСТ 2.601-2013;
• ТР ТС 010/2011;
• ТР ТС 016/2011.

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

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

Кто разработчик?

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

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

Отправить заявку на разработку руководства по эксплуатации

Вас может заинтересовать

Среди наших клиентов

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

В этой статье я поделюсь опытом написания инструкций на проекте внедрения 1С. Расскажу, как писать ПОНЯТНЫЕ руководства пользователей, и главное – как внедрить в компании регламент для сотрудников.

Руководство пользователя – это технический документ, который предназначен для оказания поддержки пользователям конкретной системы. В этом смысле используется и слово «мануал» (manual).

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

1. ОПРЕДЕЛЯЕМ ТЕМУ И ЦЕЛЕВУЮ АУДИТОРИЮ

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

• Инструкция для конкретного блока учета в программе, например, «Инструкция по блоку Продажи»,

• Инструкция для определенной должности сотрудника, например, «Инструкция для менеджера по оптовым продажам»,

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

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

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

2. ПРОДУМЫВАЕМ СТРУКТУРУ СОДЕРЖАНИЯ

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

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

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

• Встречи с заказчиком.

Инструкция по блоку. Заголовок раздела – объект программы.

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

Инструкция для должности. Заголовок раздела – название процесса.

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

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

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

3. ПИШЕМ ИНСТРУКЦИЮ

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

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

Подробная или не очень

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

Если пользователь ранее работал в подобных программах, например, менеджер по продажам имеет опыт работы с программой 1С: Управление торговлей 11, тогда ему будет не сложно заполнить нормативно-справочную информацию и создать документы «Заказ клиента» и «Реализация товаров и услуг». Такая инструкция будет содержать меньше конкретики.

Полнота изложения

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

Ветвления

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

Если вы ссылаетесь на рисунок или таблицу, то воспользуйтесь механизмом «Перекрестная ссылка».

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

Заголовки – это обязательно.

Позволяют «просканировать» ваш текст и остановиться сразу на нужной части. Но главное – не нарушать их иерархию.

Абзацы – это не так просто.

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

Списки – это удобно и понятно.

Маркированный список – это обычный список перечисления с маркерами, точками. В перечне элементы не упорядочены между собой. От их перестановки местами смысл не поменяется.

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

Пример: чтобы оформить приобретение товаров через подотчётное лицо, необходимо выполнить следующие действия:

1) Перейдите в раздел Закупки – Документы закупки (все).

2) Нажмите кнопку «Создать – Приобретение товаров и услуг – Закупка через подотчетное лицо».

3) Укажите на вкладке «Основное» следующие данные:

•  Организация,

•  Поставщик,

•  Контрагент,

•  Договор,

•  Склад.

4) Заполните вкладку «Товары».

5) Укажите на вкладке «Доставка» способ доставки.

6) Нажмите кнопку «Провести и закрыть».

Наглядность. Японское правило: «Одна картинка стоит тысячу слов».

Скриншоты 

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

Пример: чтобы установить значение цены номенклатуры в документе «Установка цен номенклатуры», необходимо выбрать подразделение, все влияющие и зависимые виды цен, затем перейти к установке:

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

• Lightshot. Скачать можно тут.

• Яндекс.Скриншот, входит в состав утилиты Яндекс.Диск. Посмотреть можно тут.

Важные фрагменты текста

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

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

Экспертность. Автор обязан хорошо разбираться в теме.

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

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

Актуальность.
Инструкцию придется периодически обновлять.

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

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

4. ПРОВЕРЯЕМ, ПРОВЕРЯЕМ И ЕЩЕ РАЗ ПРОВЕРЯЕМ

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

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

КАК ВНЕДРИТЬ ИНСТРУКЦИИ ДЛЯ СОТРУДНИКОВ

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

Правило №1. Должностные папки

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

Правило №2. Проверка знаний

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

Правило №3. Контроль выполнения

Служба ИТ-отдела должна проверять, как на самом деле выполняются регламенты в компании. Понятно, что мы не можем тратить на это много времени и ресурсов. Здесь нужно здравомыслие: просто устраивайте проверки с определенной периодичностью.

ПОДЫТОЖИМ. Для того, чтобы написать качественную инструкцию нам нужно:

1. Определить тему и целевую аудиторию.

2. Продумать структуру содержания.

3. Написать инструкцию, соблюдая следующие критерии:

• Содержательность,

• Структурированность,

• Наглядность,

• Экспертность,

• Актуальность.

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

Чтобы правильно внедрить регламент, необходимо соблюдать три правила:

1. Регламент попал к сотрудникам, и вы в этом убедились.

2. Сотрудник его прочитал, понял и прошел проверку знаний. 

3. Соблюдение регламента контролируется. 

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

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

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

По содержанию инструкции бывают:

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

Пример:

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

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

Пример:

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

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

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

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

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

Правила составления текстовых инструкций

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

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

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

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

Структура

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

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

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

122 статьи по контент-маркетингу: императорская подборка полезностей

Оформление текста

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

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

Примеры:

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

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

Примеры:

Плохо	Хорошо
Эта надпись говорит о вероятной поломке механизма.	Эта надпись говорит о поломке механизма.
Сбор данных скорее всего займет 10 минут.	Сбор данных займет 10 минут.

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

Примеры:

Плохо	Хорошо
Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок».	Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Выберите в меню режим «Блок».
Для регулировки створки вам потребуется шестигранник, шлицевая отвертка и монтажный клин.	Для регулировки створки вам понадобятся: шестигранник; шлицевая отвертка; монтажный клин.

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

Примеры:

Плохо	Хорошо
Закрепите радиатор на стене. От правого края батареи отмерьте 10 см для установки воздуховода.	Закрепите радиатор на стене. От правого края радиатора отмерьте 10 см для установки воздуховода.

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

Плохо	Хорошо
Номинальная мощность микроволновки – 700 Вт.	Номинальная мощность микроволновой печи – 700 Вт.
Граната автомобиля передает крутящий момент на ось колеса.	Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.

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

Примеры шрифтов:

С засечками	Без засечек
Допустимое напряжение в сети от 215 до 230 Вольт.	Допустимое напряжение в сети от 215 до 230 Вольт.

Иллюстрации

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

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

Как я стала писать для «Текстерры»: история бывшего копирайтера

• Услуги
• Разработка документации
• РУКОВОДСТВО ПО ЭКСПЛУАТАЦИИ. ИНСТРУКЦИЯ ПО МОНТАЖУ, ПУСКУ, РЕГУЛИРОВАНИЮ И ОБКАТКЕ ИЗДЕЛИЯ

РУКОВОДСТВО ПО ЭКСПЛУАТАЦИИ. ИНСТРУКЦИЯ ПО МОНТАЖУ, ПУСКУ, РЕГУЛИРОВАНИЮ И ОБКАТКЕ ИЗДЕЛИЯ

Руководство по эксплуатации (РЭ) – это документ, относящийся к техдокументации и сопровождающий продукцию в ходе производства или после выпуска товара на рынок. Документ содержит все основные сведения о методах функционирования устройства, оборудования, а также устанавливает требования, в соответствии с которыми продукт надлежит применять.

Разделы, которые должно содержать РЭ:

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

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

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

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

Примечания:

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

Руководство по эксплуатации и Инструкция по монтажу разрабатывается в соответствии с ГОСТ Р 2.610-2019


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