Руководство по исполь

  • 0 товаров

Каталог инструкций по эксплуатации на русском языке

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

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

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

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

Руководство по эксплуатации Нива

Содержание руководства по эксплуатации

Руководство или паспорт по эксплуатации разрабатывается, принимая за основу ГОСТ 2.601-2019, в котором описаны принципы разработки разной эксплуатационной документации технического оборудования.

Обычно руководство по эксплуатации состоит из следующих основных разделов:

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

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

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

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

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

Что касается технического оформления руководства по эксплуатации, информация об этом также прописана в ГОСТе 2.601-2019. В нём можно найти такие детали, как носитель документа, формат и качество бумаги, шрифт и размер, и многое другое.

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

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

  • Требования к руководству по эксплуатации
  • Важные правила
  • Кому может потребоваться руководство по эксплуатации?
  • Какими ГОСТ и законами регламентируется порядок оформления документа?
  • Каким должно быть содержание руководства по эксплуатации?
  • Что может быть дополнительно?
  • Как правильно оформить?
  • Стиль оформления

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

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

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

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

Важные правила

Составление РЭ проводится в соответствии с определенными правилами:

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

Кому может потребоваться руководство по эксплуатации?

Документ может быть необходим и быть полезен для:

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

Какими ГОСТ и законами регламентируется порядок оформления документа?

Порядок оформления РЭ определен рядом нормативно-правовых документов и рекомендаций стандартов ЕСКД:

  • ГОСТ 2.610-2006 – отражены общая система и правила тех. документов;
  • ГОСТ 2.105-95 – отражены правила по тексту технической документации;
  • ГОСТ 2.601-95 – указаны требования по оформлению РЭ;
  • Также существуют требования, которые регламентируются Таможенным союзом: ТР ТС 016/2011, ТР ТС 010/2011 и другие.
  • Для узконаправленной продукции оформление руководства по эксплуатации может еще регламентироваться дополнительными нормативами, например, Правилами безопасности оборудования.

Каким должно быть содержание руководства по эксплуатации?

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

  1. Вводная часть;
  2. Оглавление;
  3. Подробное описание продукта, устройства или механизма;
  4. Комплектность;
  5. Подробное описание и условия его использования;
  6. Монтаж;
  7. Сервисное обслуживание, ремонт – указание возможных неполадок и способы их устранения;
  8. Применяемые к условию стандарты, требования и нормы безопасности;
  9. Гарантии производителя;
  10. Правила по хранению и транспортировке;
  11. Правила утилизации;
  12. Предметный указатель (глоссарий).

Что может быть дополнительно?

Дополнительно РЭ часто содержит:

  • FAQ (часто задаваемые вопросы) и ответы на них;
  • Ссылки на дополнительную информацию по сфере применения товара;
  • Ссылки на обучающее видео;
  • Популярные подсказки;
  • Краткую аннотацию в начале каждого крупного раздела.

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

Как правильно оформить?

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

Стиль оформления

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

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. СВЕДЕНИЯ О ПРОИЗВОДИТЕЛЕ И ПРОДАВЦЕ

Организация:

Юридический адрес:

Фактические адрес:

Телефон:

Факс:

Электронный адрес:

Сайт:

Остались вопросы, ЗАДАВАЙТЕ

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

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

Разделы руководства пользователя:

  1. Введение.
  2. Назначение и условия применения.
  3. Подготовка к работе.
  4. Описание операций.
  5. Аварийные ситуации.
  6. Рекомендации по освоению.

1. Введение

В разделе «Введение» указывают:

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

1.1. Область применения

Требования настоящего документа применяются при:

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

1.2. Краткое описание возможностей

Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:

  • формирование табличных и кросс-табличных отчетов;
  • построение различных диаграмм;
  • экспорт и импорт результатов анализа;
  • печать результатов анализа;
  • распространение результатов анализа.

1.3. Уровень подготовки пользователя

Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:

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

Квалификация пользователя должна позволять:

  • формировать отчеты в Oracle Discoverer Plus;
  • осуществлять анализ данных.

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

  • Информационно-аналитическая система «Корпоративное хранилище данных». ПАСПОРТ;
  • Информационно-аналитическая система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

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

Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.

Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.

Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.

3. Подготовка к работе

В разделе «Подготовка к работе» указывают:

  1. состав и содержание дистрибутивного носителя данных;
  2. порядок загрузки данных и программ;
  3. порядок проверки работоспособности.

3.1. Состав и содержание дистрибутивного носителя данных

Для работы с ИАС КХД необходимо следующее программное обеспечение:

  1. Internet Explorer (входит в состав операционной системы Windows);
  2. Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.

3.2. Порядок загрузки данных и программ

Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:

  1. Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
  2. Во время загрузки в появившемся окне «Предупреждение о безопасности», которое будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator» …’ Нажимаем на кнопку «Да».
  3. После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.

3.3. Порядок проверки работоспособности

Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:

  1. Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
  2. Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
  3. В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
  4. Убедиться, что в окне открылось приложение Oracle Discoverer Plus.

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

4. Описание операций

В разделе «Описание операций» указывают:

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

Для каждой операции обработки данных указывают:

  1. наименование;
  2. условия, при соблюдении которых возможно выполнение операции;
  3. подготовительные действия;
  4. основные действия в требуемой последовательности;
  5. заключительные действия;
  6. ресурсы, расходуемые на операцию.

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

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

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

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

Задача: «Визуализация отчетности»

Операция 1: Регистрация на портале ИАС КХД

Условия, при соблюдении которых возможно выполнение операции:

  1. Компьютер пользователя подключен к корпоративной сети.
  2. Портал ИАС КХД доступен.
  3. ИАС КХД функционирует в штатном режиме.

Подготовительные действия:

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

Основные действия в требуемой последовательности:

  1. На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
  2. В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».

Заключительные действия:

Не требуются.

Ресурсы, расходуемые на операцию:

15-30 секунд.

Операция 2: Выбор отчета

Условия, при соблюдении которых возможно выполнение операции:

Успешная регистрация на Портале ИАС КХД.

Подготовительные действия:

Не требуются.

Основные действия в требуемой последовательности:

1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».

РД 50-34.698-90 Руководство пользователя (пример формирования). Oracle Discoverer

2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:

РД 50-34.698-90 Руководство пользователя (пример формирования). Oracle Discoverer

Заключительные действия:

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

Ресурсы, расходуемые на операцию:

15 секунд.

Задача: «Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

Класс ошибки Ошибка Описание ошибки Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД Сервер не найден. Невозможно отобразить страницу Возможны проблемы с сетью или с доступом к порталу ИАС КХД. Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя При регистрации на портале ИАС КХД не введено имя пользователя. Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации При регистрации на портале ИАС КХД не введен пароль. Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована. Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции Нет электропитания рабочей станции или произошел сбой в электропитании. Рабочая станция выключилась или перезагрузилась. Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

Рекомендуемая литература:

  • Oracle® Business Intelligence Discoverer Viewer User’s Guide
  • Oracle® Business Intelligence Discoverer Plus User’s Guide

Рекомендуемые курсы обучения:

  • Discoverer 10g: Создание запросов и отчетов

В качестве контрольного примера рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в п. 4.2. настоящего документа.

Руководство по эксплуатации (РЭ) описывает характеристики, конструкцию и правила использования объекта, для которого оно составлено.

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

Второе название РЭ – инструкция по эксплуатации.

Цель разработки руководства

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

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

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

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

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

Нормативно-технические акты, устанавливающие требования к РЭ:

  • ГОСТ 2.601-2013 – описывает виды эксплуатационных документов, требования к ним и комплектность;
  • ГОСТ 2.610-2006 – устанавливает правила составления различных эксплуатационных документов, в том числе РЭ.

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

Дополнительные требования к РЭ описывает ТР ТС 010/2011, действующий с 2013 года. В частности, они касаются характеристик безопасности машин и оборудования. Так, ТР ТС устанавливает необходимость доводить до потребителя информацию о потенциальной опасности при недопустимой эксплуатации. В инструкции должны прописываться ограничения условий применения и те меры безопасности, которые необходимо предпринимать, используя оборудование.

ГОСТ на оформление РЭ

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

Стандартом 2.601-2013 разрешается составление руководства в электронной форме, что подразумевает возможность размещения и на сайте производителя. Дополнительно в отношении электронного РЭ будут действовать требования ГОСТ 2.051-2013, где отражена информация о правилах составления электронной конструкторской документации.

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

Структура и содержание документа

Согласно ГОСТ 2.610-2006, устанавливающего требования к содержанию РЭ, оно должно состоять из введения и следующих разделов:

  • 1 часть – описывает оборудование и его функции;
  • 2 – содержит сведения об использовании по назначению;
  • 3  – обозначает, как должно проводиться техническое обслуживание;
  • 4 – отражает сведения о проведении текущего ремонта;
  • 5 – оговаривает правила хранения;
  • 6 – описывает информацию о правильной транспортировке;
  • 7 – содержит данные об утилизации.

В этом же ГОСТе (номер 2.610-2006) можно увидеть примеры оформления титульного листа, образец внесения данных в разные части РЭ в табличной форме.

Как разработать документ?

Для разработки инструкции следует обращаться к специалистам.

Эксперты нашего центра помогут сориентироваться во всех требованиях стандартов. Мы оказываем услуги по разработке РЭ и правильно составим его в короткие сроки.   

Какие сведения потребуются?

Для разработки РЭ специалистам нужно будет предоставить ряд документов, таких как:

  • Заявление;
  • Описание продукции;
  • Отсканированные копии учредительной документации;
  • Реквизиты заявителя.

Для уточнения информации о составлении РЭ для вашей продукции обращайтесь к специалистам нашего центра удобным для вас способом. Мы оперативно ответим на все возникшие вопросы.

From Wikipedia, the free encyclopedia

The operations manual is the documentation by which an organisation provides guidance for members and employees to perform their functions correctly and reasonably efficiently.[1] It documents the approved standard procedures for performing operations safely to produce goods and provide services.[2] Compliance with the operations manual will generally be considered as activity approved by the persons legally responsible for the organisation.[3]

The operations manual is intended to remind employees of how to do their job. The manual is either a book or folder of printed documents containing the standard operating procedures, a description of the organisational hierarchy, contact details for key personnel and emergency procedures. It does not substitute for training, but should be sufficient to allow a trained and competent person to adapt to the organisation’s specific procedures.[4]

The operations manual helps the members of the organisation to reliably and efficiently carry out their tasks with consistent results. A good manual will reduce human error and inform everyone precisely what they need to do, who they are responsible to and who they are responsible for. It is a knowledge base for the organisation, and should be available for reference whenever needed. The operations manual is a document that should be periodically reviewed and updated whenever appropriate to ensure that it remains current.[4]

Format[edit]

The operations manual can be a digital or paper document. Digital format has advantages for revision control and can be distributed easily and at low cost.[4] The detail should be sufficient to allow a competent person without specific experience to understand what is needed and how it is to be done. It is not a training manual, too much or too little detail can make it inefficient.[5]

Contents[edit]

Content will vary depending on the organisation, but some basic structure is fairly universal.[1]
Typical sections include:[4][1][5]

  • Organisational hierarchy
  • Job descriptions
  • Contact details
  • Documented processes and systems
  • Occupational health and safety instructions
  • Emergency procedures
  • Company History
  • Products & Services
  • Policies and position statements

There are two basic categories of information: Information that is relevant to all people in the organisation, and often also to clients and the general public, and information that is relevant to specific positions.[1]

There may be statutory or regulatory requirements for specific content. In some cases the CEO may be required to authorise the operations manual by signature, and this authorisation may be required to be present in the document. A version number and date of commencement may be required, and it may be a controlled document.[3]

Organogram[edit]

The organisational hierarchy is commonly and effectively described by an organisational chart, or organogram, a diagram that shows the structure of an organization and the relationships and relative ranks of its sections and members which gives the reader an easily understood picture of where key people fit into the organisation.[4]

Job descriptions[edit]

A job description is a document that describes the general tasks, duties, and responsibilities of a position, and may specify the functionary to whom the position reports, specifications such as the competence, qualifications, registration, certification or skills needed by the person in the job, and a salary range. Formal job descriptions help people understand their roles within the organisation and identify each other’s responsibilities.[5]

Contact details[edit]

These include names and contact details for key persons within the organisation and important external contacts.[5]

Documented processes[edit]

Occupational health and safety instructions[edit]

  • Risk assessments and risk management policies

Emergency procedures[edit]

Any emergency procedure that would be the standard response to a reasonably foreseeable emergency in the normal course of business would be detailed in the operations manual as a reference. There might also be specifications on how frequently exercises should be held. Some frequently encountered emergency procedures include:

  • Evacuation plans
  • Fire drills
  • Response to release of hazardous materials
  • Disaster recovery plan. How to re-establish operations following an unexpected catastrophic event.[5]

Policies[edit]

A policy is a deliberate system of principles to guide decisions and achieve rational outcomes. A policy is a statement of intent, and is implemented as a procedure or protocol. Policies are generally adopted by a governance body within an organization. Policies can assist in both subjective and objective decision making. Policies to assist in subjective decision making usually assist senior management with decisions that must be based on the relative merits of a number of factors, and as a result are often hard to test objectively, e.g. work-life balance policy. In contrast policies to assist in objective decision making are usually operational in nature and can be objectively tested, e.g. password policy.

[icon]

This section is empty. You can help by adding to it. (April 2018)

Annexures and references[edit]

Manuals that already exist for equipment or procedures may be incorporated into an operations manual as annexures, or referenced if they are not of general utility, so they can be found when needed and checked for continued validity when the operations manual is revised.[5]

Revision, updates and distribution[edit]

If an operations manual is to be useful it must be distributed to the people who will use it, and they should have the current version. Distribution and updating policies and procedures are also commonly part of the content of the manual.[1]

Specific requirements in industry[edit]

Commercial diving[edit]

In South Africa a diving contractor is obliged in terms of Regulation 21 of the Diving Regulations 2009 to provide an operations manual and make it available on site to the dive team before a diving operation may commence. This manual must contain prescribed types of information relating to health and safety, as specified in the codes of practice relating to the planned diving operations.[3] The Code of Practice for Inshore Diving requires the contractor to base the planning and implementation of diving operations on specific documents which include the operations manual.[6]

The operations manual is considered an essential administrative risk control measure, and must be compiled by the contractor in consultation with representatives of the employees and the company’s contracted diving medical practitioner. Members of the diving team are required to comply with the health and safety requirements imposed on them by the operations manual. Among other things that must be specified in the operations manual are the decompression tables or algorithms authorised for use by the dive teams, the quantities of breathing gas that must be available on site, based on the dive profile and equipment to be used, clear limits on the environmental hazards to which the divers may be exposed, and the actions required of each member of the dive team in the event of an emergency during operations.[6]

Similar requirements may apply to commercial diving contractors in other jurisdictions. The IMCA Code of Practice for Offshore Diving also requires the contractor to provide an operations manual for each diving system.[7]

Commercial airlines[edit]

  • ICAO requirements.[clarification needed]

References[edit]

  1. ^ a b c d e E-Myth Business Coach (14 October 2009). «Your Operations Manual». e-myth.com. Retrieved 26 March 2018.
  2. ^ «Definition of operations manual». Cambridge dictionary. Cambridge University Press. Retrieved 26 March 2018.
  3. ^ a b c «Diving Regulations 2009». Occupational Health and Safety Act 85 of 1993 – Regulations and Notices – Government Notice R41. Pretoria: Government Printer. Archived from the original on 2016-11-04. Retrieved 3 November 2016 – via Southern African Legal Information Institute.
  4. ^ a b c d e Mulholland, Ben (13 June 2017). «How to Create an Operations Manual for Your Business (and Avoid Nuclear War)». Process Street. Retrieved 26 March 2018.
  5. ^ a b c d e f MacNicoll, Tracy. «How to Write an Operations Manual». Edward Lowe Foundation. Retrieved 27 March 2018.
  6. ^ a b Diving Advisory Board. Code Of Practice Inshore Diving (PDF). Pretoria: The South African Department of Labour. Archived from the original (PDF) on 9 November 2016. Retrieved 16 September 2016.
  7. ^ Staff (February 2014). «IMCA International Code of Practice for Offshore Diving» (PDF). IMCA D 014 Rev. 2. London: International Marine Contractor’s Association. Retrieved 22 July 2016.[permanent dead link]
  • 0 товаров

Каталог инструкций по эксплуатации на русском языке

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

ManualsBrain

Бесплатная база инструкций и руководств для электронной техники и бытовых приборов

Watch the intro

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

#оставайтесьдома

Оставайтесь дома. Здесь вы можете найти мануалы, связанные с медициной и здоровьем

Популярные инструкции

Популярные производители

  • 3M
  • ABB
  • Amana
  • American Range
  • Avanti
  • Baumatic
  • Bertazzoni
  • BlueStar
  • Candy
  • Dacor
  • Daewoo
  • De Dietrich
  • Fagor
  • Frigidaire
  • GE
  • Gaggenau
  • Grundig
  • Heartland
  • Hitachi
  • Honeywell
  • Hoover
  • Hotpoint
  • IBM
  • Intel
  • Jenn-Air
  • KitchenAid
  • Lenovo
  • Liebherr
  • Marvel
  • Maytag
  • Miele
  • Mitsubishi Electric
  • Monogram
  • NXR
  • Neff
  • Premier
  • Schneider Electric
  • Siemens
  • Smeg
  • Sony
  • Sterling
  • Summit
  • Teka
  • Toshiba
  • U-Line
  • Verona
  • Viking
  • Whirlpool
  • Wolf
  • Zanussi

Новые инструкции и руководства


Загрузить PDF


Загрузить PDF

Руководство пользователя — это справочник на бумажном или цифровом носителе (в формате PDF или XPS), в котором приводятся инструкции по эксплуатации чего-либо или описывается правильный порядок действий для совершения какого-нибудь процесса. Хотя когда человек слышит словосочетание «руководство пользователя», он обычно представляет руководство по использованию определенной программы, инструкции по эксплуатации есть у компьютерной и бытовой техники (телевизоры, стерео-системы, телефоны, мп3-плейеры, садовая техника и и т.д.). Хорошее руководство пользователя рассказывает об основных функциях прибора или программы и объясняет, как правильно ими пользоваться, при этом информация обычно хорошо структурирована. Эта статья расскажет, о чем важно помнить при создании и оформлении руководства пользователя.

  1. Изображение с названием Create a User Manual Step 1

    1

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

    • Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
    • Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
    • Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.
  2. Изображение с названием Create a User Manual Step 2

    2

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

    • Иногда полностью исключить технические термины невозможно (например, если вы составляете инструкцию к программе для создания графиков и диаграмм, где помимо стандартных средств также используются графические инструменты Фибоначчи). В этом случае полезно дать определение термину и краткое описание (то есть что такое графики Фибоначчи и как они используются в анализе финансовых показателей).
  3. Изображение с названием Create a User Manual Step 3

    3

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

    • Если проблема сложная, разбейте ее на несколько частей. Составьте список и сопроводите каждый пункт инструкциями. Это называется разбивкой на блоки.

    Реклама

  1. Изображение с названием Create a User Manual Step 4

    1

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

    • Если руководство пользователя защищено авторским правом, соответствующее указание должно находиться на обложке и на страницах разделов.
    • Если руководство пользователя предусматривает определенные условия использования продукта и инструкции к нему, разместите эту информацию с внутренней стороны обложки.
  2. Изображение с названием Create a User Manual Step 5

    2

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

  3. Изображение с названием Create a User Manual Step 6

    3

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

  4. Изображение с названием Create a User Manual Step 7

    4

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

    • Процессы должны быть описаны четко и последовательно. Начните с общего описания задачи, затем объясните, что пользователю нужно будет сделать и какой результат он должен будет получить. Все шаги должны быть пронумерованы, а начинаться предложения должны с глаголов.
    • Справочные материалы должны включать список функций, способы диагностирования неисправностей и часто задаваемые вопросы. В конце руководства пользователя можно разместить краткий словарь терминов и алфавитный указатель, хотя основные термины часто выносятся в начало. Алфавитный указатель рекомендован для инструкций, чей объем превышает 20 страниц.
  5. Изображение с названием Create a User Manual Step 8

    5

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

    • После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
    • Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
    • Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.

    Реклама

  1. Изображение с названием Create a User Manual Step 9

    1

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

    • У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
    • Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста — например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
    • Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
    • После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.
  2. Изображение с названием Create a User Manual Step 10

    2

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

    • Как правило, название руководства пользователя и названия глав размещаются сверху или снизу страницы вместе с нумерацией страниц. Цифры могут располагаться с внешней стороны (для верха и низа страницы) или по середине (для низа). Первая страница каждого раздела может отличаться от остальных, поэтому вы можете разместить номер ее страницы по середине снизу, а номера всех остальных страниц — с внешней стороны.
    • Отдельные фрагменты текста можно выделить цветом, поместив их в специальные блоки. Важно выбрать такой оттенок, который не забивал бы текст.
    • Оставьте достаточно большие отступы со всех сторон. Со стороны переплета отступ должен быть шире.
  3. Изображение с названием Create a User Manual Step 11

    3

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

    • Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21×35 см или 11 x 27.5×42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
    • Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
    • Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.
  4. Изображение с названием Create a User Manual Step 12

    4

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

    • В текстовых редакторах и программах для публикации текста в интернете также есть функция создания «стилей», сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей («Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как «Заголовок1», «Заголовок2»; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.

    Реклама

Советы

  • По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.

Реклама

Что вам понадобится

  • Текстовый редактор или программа для публикации текста в интернете
  • Графический редактор или программа для создания скриншотов

Об этой статье

Эту страницу просматривали 50 021 раз.

Была ли эта статья полезной?

Понравилась статья? Поделить с друзьями:
  • Natureza cacau ботокс для волос инструкция
  • Как зарегистрироваться в госуслугах культура через телефон пошаговая инструкция
  • Инструкция по написанию смс на смартфоне
  • Изофра инструкция по применению цена для детей с какого возраста
  • Бактериофаг комплексный инструкция по применению для детей