Разработка руководства по эксплуатации
При выпуске в обращение технически сложной продукции в состав ее сопроводительной документации должно входить руководство по эксплуатации. Документ содержит основные правила использования, хранения и транспортировки изделия, особенности обслуживания и способы применения, позволяющие максимально продлить срок службы. РЭ также включает подробное описание продукта, в том числе, технические характеристики, параметры, конструкцию, принцип действия, инструкцию по сборке и ремонту в случае поломки.
Для чего разрабатывается РЭ?
Основной целью разработки руководства по эксплуатации является обеспечение безопасной долгосрочной работы оборудования и исключение риска причинения вреда здоровью человека. Без РЭ невозможно пройти процедуру оценки соответствия товара и получить разрешительный документ: сертификат или декларацию.
Такие сертификационные документы необходимы для законного производства и импорта оборудования и устройств.
Требования к содержанию документа
Содержание руководства по эксплуатации регламентировано действующими нормативно-правовыми актами и может незначительно отличаться в зависимости от вида и назначения продукции. Однако, несмотря на это, РЭ включает следующие обязательные разделы:
- полное наименование изделия;
- основные технические характеристики, сведения о конструктивных особенностях, основных свойствах устройства;
- составные элементы, формирующие комплектность изделия;
- принцип работы;
- меры предосторожности и обеспечения безопасной эксплуатации;
- этапы сборки и монтажа;
- указания по регулировке и наладке:
- информация о периодическом сервисном обслуживании и ремонте;
- возможные причины возникновения поломок, ошибок и правила их устранения;
- условия гарантии производителя;
- данные о периоде службы и ресурсе;
- сведения о транспортировке и упаковке;
- порядок вывода из эксплуатации и утилизации;
- данные об испытательных мероприятиях продукции;
- информация о вводе в эксплуатацию.
Дополнительные схемы, рисунки, фотографии, чертежи и таблицы способствуют более правильному восприятию пользователем сложной технической информации.
Нормативные документы
Порядок разработки инструкции по эксплуатации отражен в национальных стандартах:
- ГОСТ 2.601-2013 регулирует требования к содержанию руководства пользователя;
- ГОСТ 2.610-2006 содержит основные правила оформления РЭ.
Документом по составлению РЭ, имеющим международный статус, является технический регламент Таможенного союза. ТР ТС 010/2011, включающий в себя стандарты безопасности машин и оборудования, содержит расширенные требования к оформлению руководства по эксплуатации на технически сложные объекты.
Именно данный регламент предполагает создание РЭ как неотъемлемую часть процесса проектирования изделия. Также требования к разработке РЭ содержаться в других узкоспециализированных нормативно-технических документах международного торгово-экономического альянса (ЕАЭС), например: ТР ТС 032/2013, ТР ТС 016/2011
Правила оформления
Вся информация, изложенная в руководстве по эксплуатации, должна соответствовать требованиям действующих нормативно-технических актов. Содержание РЭ должно быть достаточным для использования как специалистом, так и простым пользователем. Документ должен быть изложен понятно и доступно, чтобы у потребителя не возникало трудностей в процессе эксплуатации продукции. Особенно это касается технически сложных объектов, машин и механизмов, подлежащих обязательной сертификации, — анализ РЭ в этом случае является важным этапом процедуры оценки соответствия.
Также в инструкции по эксплуатации должны быть отражены меры предосторожности и указания по оценке технического состояния изделия для определения необходимости текущего и внепланового ремонта. Специалисты сервисного обслуживания довольно часто используют РЭ в работе, поэтому при его составлении необходимо это учитывать, так как документ должен содержать исчерпывающую информацию, необходимую экспертам.
Согласно требованиям ТР ТС 010, руководство по эксплуатации подобно обоснованию безопасности — документу, который разрабатывается при проектировании. Таким образом, многие разделы РЭ идентичны или тесно переплетаются с положениями ОБ.
Необходимая документация
- заявка на разработку РЭ;
- информация о предприятии, инициирующем разработку инструкции по эксплуатации (наименование, реквизиты, учредительные и регистрационные документы);
- документация на изделие, устройство или оборудование.
Заказать разработку РЭ или ознакомиться с дополнительной информацией можно у сотрудников сертификационного центра «ГОСТ Р». Консультации бесплатны!
Отправьте заявку
Оформить руководство по эксплуатации необходимо, следуя требованиям национального стандарта ГОСТ 2.601-2019. В нём можно найти очень много информации об эксплуатационных документах в целом и руководстве по эксплуатации в частности.
Руководство по эксплуатации какого-либо оборудования должно содержать как общую, так и очень подробную информацию об этой машине. Оформляя руководство по эксплуатации, нужно описать:
- принципы функционирования оборудования;
- параметры и характеристики;
- комплектующие части (если есть);
- сведения по ремонту, плановому обслуживанию и утилизации.
Документ руководства по эксплуатации можно оформить как в бумажном, так и в электронном интерактивном виде для размещения на сайт и лучшего понимания функционирования аппарата.
Основные принципы оформления содержания руководства по эксплуатации
Для правильного понимания и выполнения требований руководства по эксплуатации, глаголы в тексте документа нужно использовать в повелительном наклонении: «взять», «сделать», «включить», «установить» и т.п.
Любые действия, которые нужно выполнить для достижения какого-либо результата, следует описывать в логическом порядке. Последовательность действий можно также приводить в виде таблицы.
Для сложных оборудования оформлять руководство по эксплуатации рекомендуется, разделяя текст на разделы и подразделы с соответствующей нумерацией.
Также очень важно при оформлении руководства по эксплуатации отдельно прописывать требования к безопасности, преднамеренно выделяя данные разделы или абзацы. Выделить меры безопасности можно предостерегающими словами «Внимание!», «Запрещается!» «Предупреждение!» и т.п.
Если оформляется руководство по эксплуатации на изделие, которое требует повышенной осторожности при использовании, то на титульном листе документа следует сделать соответствующую надпись: например, «ВНИМАНИЕ! ОСОБАЯ ОСТОРОЖНОСТЬ!».
Для лучшего понимания и восприятия действия и пояснений в руководстве по эксплуатации следует приводить схемы, рисунки, разные графические иллюстрации, чертежи, диаграммы, графики и т.п. В ГОСТе есть подробное описание, как и куда правильно вставлять данные изображения и иллюстрации.
Основные принципы технического оформления руководства по эксплуатации
В национальном стандарте ГОСТ Р 2.601-2019 в подразделе 8.2 можно найти подробные требования к техническому оформлению руководства по эксплуатации, если оно разрабатывается в бумажном виде.
Обычно при оформлении руководства по эксплуатации изготовитель сам решает, на каком носителе публиковать документ. Но могут быть ситуации, когда есть требования заказчика выполнить оформление руководства по эксплуатации, например, в анимационном виде на цифровом носителе. Поэтому рекомендуется консультироваться с заказчиком (если он есть) по поводу носителя руководства по эксплуатации. Особенно это касается государственных заказов.
При оформлении руководства по эксплуатации на бумажном носителе следует использовать листы А4 согласно ГОСТ 2.301. Страницу документа нужно поделить на следующие зоны:
- информационная зона с технической информацией;
- верхний колонтитул – 1-2 строчки;
- нижний колонтитул – 2-3 строчки.
Если заказчик не выдвинул требования по качеству бумаги, формату, переплёту и других технических особенностей, то их устанавливает изготовитель оборудования.
Если схем, графиков и иллюстраций слишком много, то стандарт предполагает их отдельное брошюрование в качестве приложения к руководству по эксплуатации.
При оформлении руководства по эксплуатации в электронном виде, разрешается передавать мультимедийную версию заказчику и пользователям на электронных носителях, с помощью удалённого доступа или через интернет. В зависимости от оговорённых условий, доступ к передаче электронного руководства по эксплуатации может бить единичным или многократным.
14.11.2019
Руководство по эксплуатации оборудования для получения сертификата и/или декларации соответствия
Проанализировав Поиск Яндекса и Google — поисковая система, кроме платной разработки (цены от 4500 до 8000 рублей) руководство по эксплуатации нету никакой альтернативы сделать бесплатно этот документ. Исправляем эту ситуацию. Выкладываем пример руководство по эксплуатации для самостоятельного составления этого документа. Нужно подставить свои параметры оборудования и готово.
ООО «ХХХХХХХХХ»
НАМЕНОВАНИЕ ПРОДУКЦИИ
«ХХХХХХХХХХХХХ«
РУКОВОДСТВО ПО ЭКСПЛУАТАЦИИ
20ХХ
СОДЕРЖАНИЕ
|
ВВЕДЕНИЕ |
||
|
1 |
НАЗНАЧЕНИЕ, ОСНОВНЫЕ ТЕХНИЧЕСКИЕ ДАННЫЕ, КОНСТРУКТИВНОЕ ИСПОЛНЕНИЕ |
|
|
2 |
КОМПЛЕКТНОСТЬ |
|
|
3 |
ЭКСПЛУАТАЦИЯ И УПРАВЛЕНИЕ |
|
|
4 |
ОБСЛУЖИВАНИЕ |
|
|
5 |
УКАЗАНИЕ МЕР БЕЗОПАСНОСТИ |
|
|
6 |
УСЛОВИЯ ТРАНСПОРТИРОВКИ И ХРАНЕНИЯ |
|
|
7 |
УТИЛИЗАЦИЯ |
|
|
8 |
ГАРАНТИЙНЫЕ ОБЯЗАТЕЛЬСТВА |
|
|
9 |
СВЕДЕНИЯ О ПРОИЗВОДИТЕЛЕ И ПРОДАВЦЕ |
ВВЕДЕНИЕ
Настоящее руководство по эксплуатации предназначено для ознакомления с принципом работы, основными правилами эксплуатации и обслуживания ХХХХХХХХХХХ (далее по тексту – ХХХХ, оборудование, продукция, изделие). Серийный номер: ХХХХХ. Перед началом работы внимательно ознакомьтесь с данным руководством. При проектировании, конструировании и изготовлении изделия использовалось современное производственное оборудование. Качество данного оборудования обеспечивается применением системы постоянного контроля, с использованием совершенных методов и соблюдением требований по безопасности. Эксплуатация в соответствии с инструкциями, содержащимися в данном руководстве, обеспечит надежную и безопасную работу с оборудованием.
1. НАЗНАЧЕНИЕ, ОСНОВНЫЕ ТЕХНИЧЕСКИЕ ДАННЫЕ, КОНСТРУКТИВНОЕ ИСПОЛНЕНИЕ
Оборудование представляет собой рабочее пространство, изготовленные для тестирования, нанесения и обработки ХХХХХХ. Рабочее пространство предусматривает оптимальные условия освещения, вентиляции и безопасности для вышеупомянутых процессов. Основные технические характеристики продукции указаны в таблице 1.
|
№ |
Наименование параметра |
Значение |
|
1 |
Тип установки |
|
|
2 |
Модель |
|
|
3 |
Заводской номер |
|
|
4 |
Год производства |
|
|
5 |
Суммарная потребляемая электрическая мощность |
|
|
6 |
Суммарная потребляемая электрическая мощность светильников эвакуационного освещения |
|
|
7 |
Максимальный расход воздуха |
|
|
8 |
Кратность воздухообмена |
|
|
9 |
Скорость воздушного потока внутри пустой камеры |
|
|
10 |
Максимальная тепловая мощность |
|
|
11 |
Эффективность рекуператора |
|
|
12 |
Уровень шума внутри камеры |
|
|
13 |
Внутренние размеры: Длина Ширина Высота |
|
|
14 |
Наружные размеры: Длина Ширина Высота (с учетом агрегатов и ворот) Высота |
2. КОМПЛЕКТНОСТЬ
Поставляемая продукция должна сопровождаться документом, подтверждающим ее качество (паспортом) и инструкцией по эксплуатации, соответствующей требованиям ГОСТ 2.601. Комплектность поставки изделия должна соответствовать условиям договора (заказа) и спецификации по согласованию с заказчиком. Оборудование согласно заказа поставляется полностью собранной, в комплекте с узлами и деталями. Перечень основного технологического оборудования приведен в таблице 11.
|
№ |
Наименование |
Код |
Кол-во |
Примечание |
|
1 |
||||
|
2 |
||||
|
3 |
3. ЭКСПЛУАТАЦИЯ И УПРАВЛЕНИЕ
Перед началом работы на оборудовании необходимо, внимательно изучить все инструкции и рекомендации по технике безопасности, содержащиеся в настоящем руководстве. Несоблюдение инструкций по технике безопасности может привести к выходу из строя оборудования и/или серьезным травмам. Далее расписываете эксплуатацию и управления своего оборудования.
4. ОБСЛУЖИВАНИЕ
- Перед каждым использованием проверьте оборудование на наличие повреждений и/или неисправностей.
- Основные рекомендации к проверке и техническому обслуживанию оборудования:
- Еженедельные операции:
- почистить очищающим растворителем стены и кристаллы, если на них есть краска и снова нанести вазелин;
- очистить предфильтр и фильтр для входа наружного воздуха в разные оборудования камеры;
- наблюдайте за фильтрами различных элементов извлечения воздуха, проверяя, является ли давление внутри камеры чрезмерным, и если да, замените их новыми;
- если циркулирующий воздушный поток преждевременно падает внутри без оправданной причины, проверьте натяжение ремней двигателя, предфильтр и фильтр входного воздуха и фильтры для выпуска воздуха снаружи.
- Операции раз в полгода:
- проводить еженедельную уборку более тщательно;
- заменить впускной предфильтр;
- натянуть ремни главных двигателей;
- отрегулировать механизмы закрытия служебной двери.
- Примечание: проводить инспекции и техническому обслуживание соответственно характеристикам установки.
5. УКАЗАНИЕ МЕР БЕЗОПАСНОСТИ
- ПРЕДУПРЕЖДЕНИЕ: при эксплуатации данного оборудования убедитесь в соблюдении местных нормативов техники безопасности и охраны окружающей среды, а также общих правил работы в мастерских.
- Чтобы гарантировать безопасное обслуживание установки, необходимо соблюдать рекомендации настоящего Руководства.
- Конструкция установок включает в себя функции безопасности, необходимые для устранения потенциальных рисков несчастных случаев во время использования или технического обслуживания, поскольку были учтены стандарты безопасности, действующие в С.Е.Е. такие, как ориентация на дизайн и конструкцию этой машины. Но для его правильного использования незаменима подготовка оператора, ответственного за использование машины.
- Пыль и пары, образующиеся во время работы, могут быть горючими, взрывчатыми или вредными для здоровья. Это требует принятия адекватных защитных мер (использование масок, очков, водолазов для химической защиты и т.д.)
- Строго запрещено курить или зажигать огни в установке.
- Если вы заметили какую-либо аномалию или неисправность, немедленно блокируйте устройства запуска установки и приступите к устранению недостатков.
- Некоторые незначительные действия или изменения, внесенные пользователем, могут создать риск возникновения повреждений и/или несчастных случаев, поэтому мы советуем не вносить изменений без предварительной консультации с изготовителем.
- Всегда держите систему в чистоте и в хорошем рабочем состоянии. Корректировки и ремонт должны выполняться квалифицированным персоналом по техническому обслуживанию в соответствии с инструкциями в этом Руководстве и приступая к блокировке устройств запуска и их сигнализации.
- Запрещается ходить по крыше камеры.
- Установка не должна использоваться с любой целью, кроме той, для которой она была разработана.
- Категорически запрещается использовать установку при наличии деформации или неисправности.
- Замена неоригинальных деталей, кроме оснований для аннулирования гарантии, может поставить под угрозу надлежащее функционирование установки.
- Не пытайтесь устанавливать, настраивать или управлять машиной без предварительного ознакомления с содержанием данного Руководства.
- Не пытайтесь запускать или манипулировать установкой до тех пор, пока не будут выполнены и понятны все меры безопасности, инструкции по установке и процедуры технического обслуживания.
- До начала эксплуатации оборудования потребитель должен установить все предупредительные и информационные таблички на должных местах, указанных в таблице 12.
|
Место установки на оборудовании |
предупредительные и информационные таблички |
|
Двери маляра с доступом во внутрь камеры |
|
|
Генератор, термический блок |
|
|
Экстрактор |
|
|
Сети освещения |
|
|
Шкаф управления |
|
6. УСЛОВИЯ ТРАНСПОРТИРОКИ И ХРАНЕНИЯ
6.1 Продукцию перевозят всеми видами транспорта в соответствии с правилами перевозки грузов, действующими на транспорте данного вида.
6.2 Продукция транспортируются в разобранном виде.
6.3 Все компоненты упаковываются в деревянные паллеты, при этом внутри каждого паллета компоненты крепятся к стенкам паллета, а также между собой во избежание повреждений при транспортировке. Паллеты грузятся в транспортные средства на заводе производителя при помощи мостового крана или вилочного погрузчика.
6.4 В качестве наземных транспортных средств используются грузовики ХХХХХ м. При морской транспортировке паллеты грузятся в морские контейнеры 40¨ или 40 HQ.
6.5 Изделия, их конструктивные элементы, получившие при транспортировании или выгрузке повреждения, должны храниться отдельно до принятия решения об их пригодности к эксплуатации.
6.6 В помещениях для хранения не должно быть паров кислот, щелочи, агрессивных газов и других вредных примесей, вызывающих коррозию. Транспортировать изделия следует транспортом всех видов в транспортных средствах в соответствии с правилами перевозок, действующими на транспорте данного вида.
7. УТИЛИЗАЦИЯ
Допускается утилизацию отходов в процессе производства осуществлять на договорной основе с фирмой, имеющей лицензию на утилизацию отходов.
Утилизация изделия производится в порядке, установленном Законами РФ:
- № 96-Ф3 «Об охране атмосферного воздуха» (в редакции от 28.12.2017);
- № 89- ФЗ «Об отходах производства и потребления» (в редакции от 01.01.2018);
- № 7-ФЗ «Об охране окружающей среды» (в редакции от 01.01.2018);
другими российскими и региональными нормами, актами, правилами, распоряжениями и пр., принятыми во использование указанных законов.
8. ГАРАНТИЙНЫЕ ОБЯЗАТЕЛЬСТВА
- Предприятие — изготовитель гарантирует соответствие изделия требованиям конструкторской документации, при условии соблюдения правил использования, транспортировки, хранения, монтажа и эксплуатации.
- Гарантийный срок эксплуатации – ХХ года со дня подписания акта приема – сдачи оборудования. Срок службы оборудования – до ХХ лет.
- Претензии к качеству товара могут быть предъявлены в течение гарантийного срока.
- Неисправные изделия в течение гарантийного срока ремонтируются или обмениваются на новые бесплатно. Решение о замене или ремонте изделия принимает сервисный центр. Замененное изделие или его части, полученные в результате ремонта, переходят в собственность сервисного центра.
- Затраты, связанные демонтажем, монтажом и транспортировкой неисправного изделия в период гарантийного срока потребителю не возмещаются.
- В случае необоснованности претензии, затраты на диагностику и экспертизу изделия оплачиваются потребителем.
- Изделия принимаются в гарантийный ремонт (а также при возврате) полностью укомплектованными.
- Гарантия распространяется на все дефекты, возникшие по вине завода-изготовителя.
Гарантия не распространяется на дефекты, возникшие в случаях:
- нарушения паспортных режимов хранения, монтажа, испытания, эксплуатации и обслуживания изделия;
- ненадлежащей транспортировки и погрузо-разгрузочных работ;
- наличия следов воздействия веществ, агрессивных к материалам изделия;
- наличия повреждений, вызванных пожаром, стихией, форс-мажорными обстоятельствами;
- повреждений, вызванных неправильными действиями потребителя;
- наличия следов постороннего вмешательства в конструкцию изделия.
- Производитель оставляет за собой права внесения изменений в конструкцию, улучшающие качество изделия при сохранении основных эксплуатационных характеристик.
9. СВЕДЕНИЯ О ПРОИЗВОДИТЕЛЕ И ПРОДАВЦЕ
|
Организация: |
|
|
Юридический адрес: |
|
|
Фактические адрес: |
|
|
Телефон: |
|
|
Факс: |
|
|
Электронный адрес: |
|
|
Сайт: |
Остались вопросы, ЗАДАВАЙТЕ
Инструкция – справочный документ, где собраны правила эксплуатации товара. Это может быть руководство пользователя бытовой техники, указания к применению лекарственного препарата, статья в разделе FAQ или текст на пачке риса. Продавец обязан предоставить покупателю информацию о товаре согласно статье 10 закона России «О защите прав потребителей».
Написать понятную инструкцию – рассказать о технически сложном товаре простым языком, без потери смысла.
Виды инструкций
По содержанию инструкции бывают:
- Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.
Пример:
«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».
- Сценарные. Сценарная инструкция – это пошаговое руководство для решения конкретной задачи. Например, как заменить струны на гитаре, запустить автотаймер регистратора или сварить пельмени.
Пример:
«Включите стиральную машину с помощью кнопки СТАРТ.
Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».
Сценарные инструкции, кроме перечисления действий, обучают пользователя лайфхакам, профессиональным хитростям, горячим клавишам. Например, не все знают, что между рельсом встроенного шкафа-купе и потолком из гипсокартона нужно подложить фанеру. Иначе крепление со временем ослабнет.
Материалы сборки велосипеда – описательная инструкция, а порядок замены пробитой шины – сценарная.
Еще инструкции разделяются по формату:
- текстовые;
- видеоинструкции;
- скринкастинг – запись действий с экрана компьютера;
- инфографика – подборка иллюстраций для быстрой передачи сути;
- FAQ – справочный раздел сайта для ответов на популярные вопросы.
Выбор формата зависит от продукта. Например, видео и скринкастинг хорошо расскажут о программном обеспечении. Инфографика наглядно продемонстрирует процесс сборки/разборки мебели. Текстовые (печатные и электронные) подходят для большинства физических товаров и объединяют несколько форматов в один документ.
Продвинем ваш бизнес
В Google и «Яндексе», соцсетях, рассылках, на видеоплатформах, у блогеров
Подробнее
Правила составления текстовых инструкций
Первым делом определитесь с покупателем товара и обстоятельствами, при которых инструкцию будут читать. Например, инструкцию для автомобильной фары читают в гараже или СТО. Поэтому разделите ее на два документа. В одном – расскажите о характеристиках, производителе, особенностях. В другом – покажите схему подключения. Желательно распечатать руководство на плотной бумаге, которая не порвется от многократного использования.
Для простых товаров, где не требуется подробное описание функций (например, компьютерная мышь) инструкция пишется в сжатой форме. Про новые товары на рынке, наоборот, стоит рассказать подробнее.
Кроме того, важен опыт покупателя. Например, профессиональным мебельщикам не интересен порядок установки фасадов – они и так это знают. Домохозяйкам и новичкам стоит объяснять все «на пальцах».
Очевидно, что инструкции для дизельного генератора и чайника отличаются по объему и содержанию. Однако принципы составления для любого продукта – одинаковые.
Структура
Типовая инструкция включает следующие разделы:
- общая характеристика и назначение товара;
- техника безопасности;
- обзор возможностей;
- принцип работы;
- установка;
- устранение неисправностей;
- гарантийные обязательства.
Составьте оглавление, если в инструкции более 5 листов. Это позволит читателю быстро перейти к нужному разделу и не искать информацию в интернете.
Спасибо!
Ваша заявка принята.
Мы свяжемся с вами в ближайшее время.
122 статьи по контент-маркетингу: императорская подборка полезностей
Оформление текста
Понятные инструкции – это инструкции, написанные в форме диалога с читателем. По возможности не используйте технические термины. Будьте последовательны в изложении. Например, не стоит писать про неисправности до перечисления режимов работы прибора.
Инструкция – официальный документ, поэтому уберите из текста воду, пустословия и личные суждения. При описании порядка действий глаголы ставьте в повелительное наклонение.
Примеры:
|
Плохо |
Хорошо |
|
Для этого необходимо перейти в режим записи видео. |
Перейдите в режим записи видео. |
|
Ламинированное покрытие нужно протирать обычными моющими средствами. |
Протирайте ламинированное покрытие обычными моющими средствами. |
|
Все детали фурнитуры для получения легкого хода должны смазываться не реже 1 раза в год машинным маслом. |
Смазывайте фурнитуру не реже 1 раза в год машинным маслом для получения легкого хода. |
Избегайте слов «скорее всего», «наверно», «вероятно», «может быть» и подобных. Они вызывают чувство сомнения в экспертности автора.
Примеры:
|
Плохо |
Хорошо |
|
Эта надпись говорит о вероятной поломке механизма. |
Эта надпись говорит о поломке механизма. |
|
Сбор данных скорее всего займет 10 минут. |
Сбор данных займет 10 минут. |
Структурируйте материал на тематические блоки. Используйте нумерованные и маркированные списки. Для лучшего восприятия текста оставляйте межстрочный интервал, а сами абзацы делайте короткими.
Примеры:
|
Плохо |
Хорошо |
|
Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок». |
|
|
Для регулировки створки вам потребуется шестигранник, шлицевая отвертка и монтажный клин. |
Для регулировки створки вам понадобятся:
|
Не используйте синонимы одного и того же термина. Они могут означать разные вещи. Читатель должен понять смысл, а не оценить словарный запас автора.
Примеры:
|
Плохо |
Хорошо |
|
|
В документе недопустимо использование просторечий, сленговых выражений, жаргонизмов.
|
Плохо |
Хорошо |
|
Номинальная мощность микроволновки – 700 Вт. |
Номинальная мощность микроволновой печи – 700 Вт. |
|
Граната автомобиля передает крутящий момент на ось колеса. |
Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса. |
Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.
Чем крупнее шрифт, тем сложнее его читать без засечек. Исключения – заголовки, цитаты и врезки с важной информацией.
Примеры шрифтов:
|
С засечками |
Без засечек |
|
Допустимое напряжение в сети от 215 до 230 Вольт. |
Допустимое напряжение в сети от 215 до 230 Вольт. |
Иллюстрации
Картинки дополняют текст, быстрее доносят смысл и сокращают объем документа. Иллюстрациями могут быть схемы монтажа, скриншоты с экрана, графики, таблицы, векторные рисунки или реальные фотографии. Главное, чтобы картинки имели одинаковый размер и стиль.
Сделать скриншот можно с помощью горячих клавиш компьютера. Но для создания ярких изображений без знания специальных программ не обойтись. Например, графический редактор Adobe Photoshop позволяет рисовать и обрабатывать картинки любой сложности. Бесплатная версия для ознакомления доступна в интернете, но для полноценной работы стоит купить программу со всеми инструментами дизайнера.
Как я стала писать для «Текстерры»: история бывшего копирайтера
Загрузить PDF
Загрузить PDF
Руководство пользователя — это справочник на бумажном или цифровом носителе (в формате PDF или XPS), в котором приводятся инструкции по эксплуатации чего-либо или описывается правильный порядок действий для совершения какого-нибудь процесса. Хотя когда человек слышит словосочетание «руководство пользователя», он обычно представляет руководство по использованию определенной программы, инструкции по эксплуатации есть у компьютерной и бытовой техники (телевизоры, стерео-системы, телефоны, мп3-плейеры, садовая техника и и т.д.). Хорошее руководство пользователя рассказывает об основных функциях прибора или программы и объясняет, как правильно ими пользоваться, при этом информация обычно хорошо структурирована. Эта статья расскажет, о чем важно помнить при создании и оформлении руководства пользователя.
-
1
Определите, кто ваш читатель. Чтобы создать хорошее руководство пользователя, нужно понимать, какой человек купит то устройство, к которому вы создаете инструкцию. Можно записать свои мысли, а можно просто представить себе этого человека. Это полезно делать, если вы работаете в команде по созданию документации и если вы участвуете в разработке продукта от самого начала до конца. Подумайте о следующем:
- Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
- Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
- Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.
-
2
Пишите так, чтобы читатель вас понял. Если только ваш товар не предполагает наличие узких знаний у пользователя, лучше избегать технических терминов и описывать все простым, понятным языком. Структура текста должна соответствовать последовательности вопросов, которые могут возникать у пользователя. Правильнее группировать функции прибора в зависимости от задач, которые он выполняет, и отказаться от идеи объединения в одну группу самых популярных функций.
- Иногда полностью исключить технические термины невозможно (например, если вы составляете инструкцию к программе для создания графиков и диаграмм, где помимо стандартных средств также используются графические инструменты Фибоначчи). В этом случае полезно дать определение термину и краткое описание (то есть что такое графики Фибоначчи и как они используются в анализе финансовых показателей).
-
3
Опишите проблему, с которой может столкнуться пользователь, а затем предложите решение. Когда вы рекламируете какой-то продукт, фразы о том, как он сможет решить определенную проблему, несомненно привлекут много внимания. Но когда пользователь купит этот продукт, ему нужно объяснить, что с ним делать. Опишите, с какими проблемами может столкнуться пользователь в процессе эксплуатации, и включите в руководство инструкции по разрешению этих проблем.
- Если проблема сложная, разбейте ее на несколько частей. Составьте список и сопроводите каждый пункт инструкциями. Это называется разбивкой на блоки.
Реклама
-
1
Продумайте обложку и оформление первых страниц разделов. Вам потребуется создать обложку, если инструкция занимает несколько страниц. Необходимо будет также оформить страницы с названием разделов для инструкций, где общее количество информации занимает более 4 страниц.
- Если руководство пользователя защищено авторским правом, соответствующее указание должно находиться на обложке и на страницах разделов.
- Если руководство пользователя предусматривает определенные условия использования продукта и инструкции к нему, разместите эту информацию с внутренней стороны обложки.
-
2
Ссылки на дополнительную документацию разместите в введении. Если руководство состоит из нескольких брошюр, укажите все номера брошюр в начале. Кроме того, здесь также следует разместить раздел «Как использовать эту инструкцию по эксплуатации», если вы решили, что такой раздел необходим.
-
3
Если количество страниц превышает 10 штук, вам понадобится оглавление.
-
4
Основу руководства по эксплуатации должны составлять инструкции и информация о составных частях товара. Как правило, инструкции разбивают на блоки, и в каждом блоке можно указать, в каких разделах пользователю стоит искать ту или иную информацию. Так пользователю будет проще и быстрее находить нужные ему сведения.
- Процессы должны быть описаны четко и последовательно. Начните с общего описания задачи, затем объясните, что пользователю нужно будет сделать и какой результат он должен будет получить. Все шаги должны быть пронумерованы, а начинаться предложения должны с глаголов.
- Справочные материалы должны включать список функций, способы диагностирования неисправностей и часто задаваемые вопросы. В конце руководства пользователя можно разместить краткий словарь терминов и алфавитный указатель, хотя основные термины часто выносятся в начало. Алфавитный указатель рекомендован для инструкций, чей объем превышает 20 страниц.
-
5
Используйте изображения и схемы. Рисунки и скриншоты могут описать определенные процессы лучше, чем текст, особенно если речь идет от сложных процессах, где необходимо иметь визуальное подтверждение тому, что человек все делает верно. Графические изображения можно создать в специальных программах: в системах двух- и трехмерного черчения, в графических редакторах, в приложениях для обработки фотографий и т.д. Если необходимо сделать скриншоты, их можно получить с помощью штатных средств комьпютера и графической программы с возможностью сохранения скриншотов.
- После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
- Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
- Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.
Реклама
-
1
Выберите читаемый шрифт. Хотя компьютеры поддерживают разные шрифты, руководство пользователя должно быть хорошо читаемым, поэтому отдавайте предпочтение самым простым. Лучше всего подобрать несколько шрифтов, которые хорошо смотрятся вместе. Есть два типа шрифтов: с засечками и без засечек.
- У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
- Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста — например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
- Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
- После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.
-
2
Продумайте схему расположения информационных блоков. На этом этапе вам нужно решить, в каком порядке размещать информацию.
- Как правило, название руководства пользователя и названия глав размещаются сверху или снизу страницы вместе с нумерацией страниц. Цифры могут располагаться с внешней стороны (для верха и низа страницы) или по середине (для низа). Первая страница каждого раздела может отличаться от остальных, поэтому вы можете разместить номер ее страницы по середине снизу, а номера всех остальных страниц — с внешней стороны.
- Отдельные фрагменты текста можно выделить цветом, поместив их в специальные блоки. Важно выбрать такой оттенок, который не забивал бы текст.
- Оставьте достаточно большие отступы со всех сторон. Со стороны переплета отступ должен быть шире.
-
3
Подумайте над типом переплета. Если в вашем руководстве пользователя больше 4-х страниц, вам потребуется переплет. Документы для внутреннего пользования обычно скрепляют степлером в углу, но если вы будете вкладывать свое руководство в коробку с товаром, вам нужно будет подойти к этому вопросу более ответственно. Есть три типа переплета:
- Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21×35 см или 11 x 27.5×42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
- Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
- Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.
-
4
Сверстайте документ. В большинстве текстовых редакторов и программ для публикации текста в интернете предусмотрена возможность верстки. По мере того, как вы будете набирать текст, он будет автоматически отображаться в выбранном шрифте. (Эта статья была изначально написана с помощью шаблона в Microsoft Word.) В этих программах также есть уже готовые шаблоны, которые вы можете изменить с учетом своих потребностей, вместо того, чтобы создавать шаблон с нуля.
- В текстовых редакторах и программах для публикации текста в интернете также есть функция создания «стилей», сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей («Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как «Заголовок1», «Заголовок2»; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.
Реклама
Советы
- По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.
Реклама
Что вам понадобится
- Текстовый редактор или программа для публикации текста в интернете
- Графический редактор или программа для создания скриншотов
Об этой статье
Эту страницу просматривали 50 021 раз.