-
0 ₽ 0 товаров
Каталог инструкций по эксплуатации на русском языке
В нашем каталоге более 90.000 инструкций по эксплуатации и руководств пользователя на русском языке к бытовой технике и электронике. Чтобы скачать инструкцию по эксплуатации выберите интересую вас категорию или воспользуйтесь поиском в верхнем правом углу сайта.
User guide или руководство пользователя — это документ, содержащий подробную информацию о том, как пользоваться определенным продуктом, услугой или системой. Он предназначен для конечных пользователей и помогает им быстро освоиться и начать эффективно использовать продукт. Давайте разберемся, что представляет собой user guide.
Описание продукта
В этом разделе дается общее представление о продукте — его назначении, основных возможностях и преимуществах. Это помогает пользователю понять, зачем нужен данный продукт и что конкретно он может.
Пошаговые инструкции
Это самая важная часть user guide. Здесь подробно описывается, как выполнять различные задачи с помощью продукта: как установить, настроить, пользоваться основными и дополнительными функциями. Инструкции обычно структурированы по разделам и сопровождаются скриншотами.
Ответы на частые вопросы
Раздел FAQ содержит ответы на наиболее распространенные вопросы пользователей. Это позволяет быстро найти решение типичных проблем без чтения всего руководства.
Кроме того, в user guide могут входить:
- Справочная информация о продукте
- Описание интерфейса и основных элементов управления
- Рекомендации по безопасности
- Устранение неполадок
- Глоссарий терминов
Инструкция на русском языке users guide пишется простым и понятным языком, с минимумом технических терминов. Текст должен быть структурирован с использованием заголовков, списков, выделений. Важную информацию можно оформить в виде советов и предупреждений.
Как правильно пользоваться руководством пользователя
Чтобы максимально эффективно использовать user guide, рекомендуется:
- Внимательно изучить описание продукта, чтобы получить общее представление о его возможностях
- Не читать руководство от корки до корки, а обращаться к нужным разделам по мере необходимости
- Следовать инструкциям точно в указанном порядке
- Использовать встроенную систему поиска, чтобы быстро найти нужный раздел
- Задавать вопросы производителю, если что-то осталось непонятным
Если вы приобрели новое устройство или программное обеспечение, обязательно изучите прилагаемое руководство пользователя. Это поможет быстрее освоить продукт и использовать все его возможности. Современные user guide создаются с учетом удобства пользователя и содержат полезную информацию в доступной форме.
Как составить качественное руководство пользователя
Для создания по-настоящему полезного и удобного в использовании user guide необходимо придерживаться следующих правил:
- Провести анализ целевой аудитории, ее потребностей и уровня подготовки
- Структурировать информацию — использовать заголовки, списки, схемы, таблицы
- Писать простым языком, объяснять специальные термины
- Давать четкие и подробные инструкции в логической последовательности
- Использовать наглядные скриншоты и иллюстрации
- Отдельно выделять важные предупреждения о возможных проблемах
- Добавить раздел FAQ, отражающий реальные вопросы пользователей
- Проверить руководство с точки зрения пользователя, убедиться, что все понятно
Следуя этим рекомендациям при разработке, можно создать по-настоящему полезный продукт, который поможет пользователям быстро разобраться в новом устройстве или программе.
User guide что это остается одним из наиболее важных элементов пользовательского опыта. Качественно составленное руководство повышает лояльность клиентов, помогает избежать лишних вопросов в службу поддержки. Поэтому стоит уделять его созданию должное внимание.
User Guide (юзер гайд) — это руководство пользователя. Иногда встречается название User Manual, что тоже можно перевести как руководство пользователя.
User Guide (Руководство пользователя) — это документ, либо приложение, предназначенные для того, чтобы предоставить помощь в использовании компьютера, смартфона, планшета, либо в использовании программы, а также в использовании сайта.
Содержание:
1. Чем полезен User Guide
2. Можно ли удалить User Guide с компьютера
3. Видео: Что такое User Guide и User Manual, польза для пользователя и можно ли это удалить с компьютера
Чем полезен User Guide
У ноутбуков нет единых стандартов, например, при использовании функциональных клавиш. У смартфонов тоже нет единых стандартов. Поэтому каждый производитель ноутбука или смартфона поступает по принципу «кто во что горазд», каждый по-своему. Узнать индивидуальные особенности своего компьютера, смартфона, планшета, ноутбука можно как раз из руководства пользователя — юзер гайда.
При покупке ноутбука раньше выдавалось руководство пользователя в виде небольшой бумажной книжечки, либо он был на диске в той коробке, в которой продавался ноутбук. Сейчас юзер гайд может быть либо в виде приложения на смартфоне, либо на ноутбуке — это файл в формате PDF.
Руководством можно пользоваться, от него вреда нет, только сплошная польза и помощь при освоении своего устройства.
Например, на моем ноутбуке есть файл User_Manual.pdf. Там описывается, как можно подключиться к интернету, какие есть особенности у сенсорной панели, у тачпада и другие параметры конкретной модели ноутбука.
User Manual на ноутбуке в формате pdf — титульный лист.
Где еще искать юзер гайд для своего устройства? Можно открыть официальный сайт производителя ноутбука. Если ввести серийный номер ноутбука, то, возможно, есть инструкции для вашей модели на этом сайте.
Юзер гайд на сайтах
На некоторых сайтах можно встретить руководство для пользователя. В качестве примера возьмем сайт Петроэлектросбыта:
На сайте Петроэлектросбыта находится «Инструкция пользователя».
На сайте Петроэлектросбыта внизу, в подвале находится ссылка «Инструкция пользователя». Если по ней кликнуть, сразу же скачается руководство пользователя на 43 листах — файл в формате PDF.
Там подробнейшим образом описано, как можно зарегистрироваться в личном кабинете, как производить оплаты, платежи за электричество и коммунальные платежи. Все очень подробно описано, со скриншотами — полезная вещь для тех, кто впервые имеет дело с этим сайтом.
Можно ли удалить Юзер гайд с компьютера
Не совсем понимаю некоторых пользователей, у которых возникает желание удалить свой юзер гайд на компьютере. Его удалить можно, ничего страшного не произойдет, система будет работать и дальше.
Но если вдруг возникнет необходимость, а никогда не известно когда она может возникнуть, то где взять это руководство? Не понятно, особенно если нельзя восстановить файлы из архива, чтобы вернуть юзер гайд.
Видео: Что такое User Guide и User Manual, польза для пользователя и можно ли это удалить с компьютера
Руководство пользователя — это полезная вещь, которая облегчает освоение своего устройства. Спасибо за внимание!
Другие материалы:
1. А как у Вас с английским и с другими языками: Google переводчик бесплатно для текста, документа, сайта и речи
2. Компьютерный жаргон: словарик некоторых терминов и их разбор
3. Почему краткость в формулировке вопроса не является сестрой таланта
Получайте новые статьи по компьютерной грамотности на ваш почтовый ящик:
Необходимо подтвердить подписку в своей почте. Спасибо!
-
0 ₽ 0 товаров
Каталог инструкций по эксплуатации на русском языке
В нашем каталоге более 90.000 инструкций по эксплуатации и руководств пользователя на русском языке к бытовой технике и электронике. Чтобы скачать инструкцию по эксплуатации выберите интересую вас категорию или воспользуйтесь поиском в верхнем правом углу сайта.
руководство по эксплуатации
РЭ
—
[Интент]
руководство по технической эксплуатации
—
[Л.Г.Суменко. Англо-русский словарь по информационным технологиям. М.: ГП ЦНИИС, 2003.]
Руководство по эксплуатации (РЭ) по ГОСТ 2.601-95
РЭ, как правило, состоит из введения и следующих частей:
- описание и работа;
- использование по назначению;
- техническое обслуживание;
- текущий ремонт;
- хранение;
- транспортирование;
- утилизация.
Введение излагают без заголовка. Оно содержит:
- назначение и состав РЭ;
- требуемый уровень специальной подготовки обслуживающего персонала;
- распространение РЭ на модификации изделия;
- другие сведения (при необходимости).
Для изделий, которые при определенных условиях могут представлять опасность для жизни и здоровья человека, во введении должна быть приведена информация о видах опасных воздействий
Часть «Описание и работа» состоит из разделов:
- описание и работа изделия;
- описание и работа составных частей изделия.
Раздел «Описание и работа изделия» содержит:
- назначение изделия;
- характеристики (свойства);
- состав изделия;
- устройство и работа;
- средства измерения, инструмент и принадлежности;
- маркировка и пломбирование;
- упаковка.
Подраздел «Назначение изделия» содержит наименование изделия, его обозначение, назначение, область применения, параметры, размеры, характеризующие условия эксплуатации.
Подраздел «Технические характеристики» содержит технические данные, основные параметры и характеристики (свойства), необходимые для изучения и правильной технической эксплуатации изделия. При изложении сведений о контролируемых (измеряемых) параметрах необходимо указывать: наименование параметра; номинальное значение, допуск (доверительный интервал); применяемое средство измерения
Подраздел «Состав изделия» содержит наименования, обозначения и места расположения основных составных частей изделия и установленных для изделия комплектов ЗИП. Здесь же указывают общие отличия в конструкции различных модификаций изделий от базового изделия и друг от друга и особенности их комплектации. Допускается приводить схему деления изделия на составные части
Подраздел «Устройство и работа» содержит общие сведения о принципе действия, устройстве и режимах работы изделия в целом, взаимодействии составных частей изделия. Здесь же указывают, при необходимости, взаимодействие данного изделия с другими изделиями
Подраздел «Средства измерения, инструмент и принадлежности» содержит назначение, перечень, места расположения и краткие основные технические (в том числе метрологические) характеристики, а также устройство и принцип действия специальных средств измерения, испытательного и другого оборудования, инструмента и принадлежностей, которые необходимы для контроля, регулирования (настройки), выполнения работ по техническому обслуживанию и текущему ремонту изделия и его составных частей
Подраздел «Маркировка и пломбирование» содержит сведения для всего изделия в целом о маркировании и пломбировании изделия, тары и упаковочных материалов
Подраздел «Упаковка» содержит для всего изделия в целом описание конструкции и порядка использования тары, упаковочных материалов и т. п., порядок пломбирования и распломбирования
Раздел «Описание и работа составных частей изделия» содержит общие сведения о составных частях изделия и состоит из подразделов:
- общие сведения;
- описание;
- работа;
- маркировка и пломбирование;
- упаковка.
Подраздел «Общие сведения» содержит в общем виде назначение и описание составных частей изделия, из каких основных составных частей более мелкого уровня деления состоит описываемая составная часть изделия, где они расположены, какие выполняют функции, их взаимосвязь и др.
Подраздел «Работа» содержит описание работы составных частей изделия
Содержание подразделов «Маркировка и пломбирование» и «Упаковка» составных частей изделия аналогично содержанию подразделов для изделия в целом
Часть «Использование по назначению» состоит из разделов:
- эксплуатационные ограничения;
- подготовка изделия к использованию;
- использование изделия;
- действия в экстремальных условиях;
- особенности использования доработанного изделия.
Раздел «Эксплуатационные ограничения» содержит те технические характеристики изделия, несоблюдение которых недопустимо по условиям безопасности и которые могут привести к выходу изделия из строя. Эти характеристики, с указанием их количественных значений, рекомендуется излагать в виде таблиц в порядке, соответствующем последовательности этапа использования изделия по назначению.
Все ограничения, помещаемые в данном разделе, должны обеспечивать возможность их контроля обслуживающим персоналом
Раздел «Подготовка изделия к использованию» содержит указания по проверке и приведению изделия к использованию по назначению.
Раздел, как правило, содержит подразделы:
- меры безопасности при подготовке изделия;
- правила и порядок заправки изделия топливом, маслами, смазками, газами, жидкостями и другими материалами (далее — ГСМ) с указанием их количества и марки, а также условия и порядок заправки дублирующими (резервными) ГСМ и, при необходимости, зарубежными ГСМ;
- объем и последовательность внешнего осмотра изделия;
- правила и порядок осмотра рабочих мест;
- правила и порядок осмотра и проверки готовности изделия к использованию;
- описание положений органов управления и настройки после подготовки изделия к работе и перед включением;
- указания об ориентировании изделия (с приложением схем при необходимости);
- особенности подготовки изделия к использованию из различных степеней готовности;
- при необходимости, указания о взаимосвязи (соединении) данного изделия с другими изделиями;
- указания по включению и опробованию работы изделия с описанием операций по проверке изделия в работе, в том числе с помощью средств измерения, входящих в состав изделия (приводятся значения показаний средств измерений, соответствующие установленным режимам работы, и допустимые отклонения от этих значений);
- перечень возможных неисправностей изделия в процессе его подготовки и рекомендации по действиям при их возникновении.
Раздел «Использование изделия» содержит, как правило, подразделы:
- порядок действия обслуживающего персонала при выполнении задач применения изделия;
- порядок контроля работоспособности изделия в целом с описанием методик выполнения измерений, регулирования (настройки), наладки изделия, а также схем соединения изделия со средствами измерений и вспомогательными устройствами, используемых для измерений;
- перечень возможных неисправностей в процессе использования изделия по назначению и рекомендации по действиям при их возникновении;
- перечень режимов работы изделия, а также характеристики основных режимов работы;
- порядок и правила перевода изделия с одного режима работы на другой с указанием необходимого для этого времени;
- порядок приведения изделия в исходное положение;
- порядок выключения изделия, содержание и последовательность осмотра изделия после окончания работы;
- порядок замены, пополнения и контроля качества (при необходимости) ГСМ;
- меры безопасности при использовании изделия по назначению. При этом должны быть отражены требования, обеспечивающие безопасность обслуживающего персонала, техники и экологическая безопасность проводимых работ.
Раздел «Действия в экстремальных условиях» содержит случаи отказа изделия в экстремальных условиях и условия, которые могут привести к аварийной ситуации. Раздел содержит, как правило, действия в следующих случаях:
- при пожаре на изделии на различных этапах использования изделия;
- при отказах систем изделия, способных привести к возникновению опасных аварийных ситуаций;
- при попадании в аварийные условия эксплуатации;
- при экстренной эвакуации обслуживающего персонала.
Раздел «Особенности использования доработанного изделия» содержит:
- основные конструктивные отличия данного изделия от базового изделия и обусловленные ими изменения в эксплуатационных ограничениях и рекомендациях по эксплуатации;
- особенности выполнения операций на всех этапах подготовки и использования по назначению модифицированного изделия.
Допускается эти особенности приводить в тексте РЭ, не выделяя в отдельный раздел
Часть «Техническое обслуживание» содержит сведения по техническому обслуживанию (ТО) изделия и его составных частей и состоит из разделов:
- техническое обслуживание изделия;
- техническое обслуживание составных частей изделия. Изделие и его составные части, на которых проводят работы по техническому обслуживанию (далее — объекты ТО), виды и объемы работ и периодичность их выполнения зависят от уровня надежности объектов ТО при условии оптимальных сроков проведения ТО и расходов материальных средств и трудовых ресурсов на ТО.
Раздел «Техническое обслуживание изделия» состоит из подразделов:
- общие указания;
- меры безопасности;
- порядок технического обслуживания изделия;
- проверка работоспособности изделия;
- техническое освидетельствование;
- консервация (расконсервация, переконсервация).
Подраздел «Общие указания» содержит:
- характеристику принятой системы ТО: виды, объемы и периодичность ТО, особенности организации ТО изделия и его составных частей в зависимости от этапов его эксплуатации (использование по назначению, хранение, транспортирование и т. д.) и условий эксплуатации (климатические, временные и т. д.), указания по организации ТО;
- требования к составу и квалификации обслуживающего персонала;
- требования к изделию, направляемому на ТО;
- перечень основных и дублирующих (резервных) ГСМ и, при необходимости, зарубежных эквивалентов для них, применяемых в изделии.
Перечень ГСМ, применяемых в изделии, рекомендуется излагать в виде таблицы 3.
Таблицу 3 заполняют на основании химитологической карты по ГОСТ 25549.
Графа «Норма расхода ГСМ» заполняется в случае необходимости определения расхода ГСМ на расчетный период времени или наработки.
Графа «Периодичность способов смены (пополнения) ГСМ» заполняется в случае наличия в РЭ схемы заправки ГСМ. При необходимости допускается указывать дублирующие, резервные ГСМ, а также зарубежные ГСМ-аналоги [из п. 5.1.5.1.1 ГОСТ 2.601-95]
Подраздел «Меры безопасности» содержит правила, которые необходимо соблюдать в соответствии с особенностями конструкции изделия и его эксплуатации, действующими положениями нормативных документов, а также перечень обязательных требований по техническому обслуживанию и (или) ремонту, невыполнение которых может привести к опасным последствиям для жизни, здоровья человека или окружающей среды. Здесь же излагают правила пожарной безопасности, взрывобезопасности и т. п. [из п. 5.1.5.1.2 ГОСТ 2.601-95]
Подраздел «Порядок технического обслуживания изделия» содержит характеристику каждого вида ТО изделия и его составных частей, в том числе замена смазки, заправка специальными жидкостями, кислородом и др., дренаж трубопроводов и агрегатов и т. д. в зависимости от особенностей и условий эксплуатации, периодичность видов ТО, в том числе и при хранении, сведения по всем видам ТО, принятым для эксплуатируемого изделия.
Содержание подраздела рекомендуется излагать в виде таблицы 4.
Таблица 4 — Порядок технического обслуживания
В графе «Пункт РЭ» указывают порядковый номер пункта (работы), под ним номер раздела, подраздела, пункта РЭ.
В графе «Наименование объекта ТО и работа» приводят наименование объекта ТО и перечень работ, проводимых при ТО.
В графе «Виды ТО» приводят условное обозначение вида ТО или периода выполнения видов ТО, а также условное обозначение выполняемой («+») или невыполняемой («-») работы. Графа может состоять из одной или нескольких колонок
Подраздел «Проверка работоспособности изделия» содержит последовательность выполнения работ по проверке работоспособности изделия.
Содержание подраздела рекомендуется излагать в виде таблицы 5.
Таблица 5 — Проверка работоспособности
В графе «Наименование работы» приводят наименование выполняемой работы в последовательности их выполнения.
В графе «Кто выполняет» указывают в сокращенном виде, кто выполняет работу, например М — механик, О — оператор и т. д.
В графе «Средства измерений, вспомогательные технические устройства и материалы» указывают измерительные и вспомогательные устройства, а также материалы, не входящие в изделие, но которые необходимо использовать.
В графе «Контрольные значения параметров» указывают значения, в пределах которых должны находиться параметры, контролируемые при проверке исправности изделия, и значения параметров, при которых изделие отправляют в ремонт. При изложении сведений о контролируемых (измеряемых) параметрах необходимо указывать: наименование параметра; номинальное значение; допуск (доверительный интервал); применяемое средство измерения.
В подразделе также приводят указания о порядке проведения пред ремонтной дефектации изделия с целью оценки его технического состояния и определения необходимости отправки изделия в капитальный (средний) ремонт
Подраздел «Техническое освидетельствование» содержит порядок и периодичность освидетельствования изделия (и) или его составных частей органами инспекции и надзора, а также указывают, в каком месте формуляра или паспорта приведен перечень поверяемых средств измерения, освидетельствованных сосудов, работающих под высоким давлением, грузоподъемных средств, входящих в изделие и его комплекты. Здесь же указывают требования по подготовке средств измерений к поверке и методики поверки встроенных средств измерений без демонтажа их с изделия
Подраздел «Консервация (расконсервация, переконсервация)» содержит сведения о средствах и методах наружной и внутренней консервации, расконсервации, переконсервации (далее — консервации) изделия в целом, периодичности консервации при хранении, порядок приведения изделия в состояние готовности к использованию по назначению из состояния консервации, перечень используемых инструментов, приспособлений и материалов [из п. 5.1.5.1.6 ГОСТ 2.601-95]
Раздел «Техническое обслуживание составных частей изделия», как правило, содержит подразделы:
- обслуживание;
- демонтаж и монтаж;
- регулирование и испытание;
- осмотр и проверка;
- очистка и окраска;
- консервация.
Подраздел «Обслуживание» содержит правила и порядок замены и заправки изделия ГСМ с указанием их количества и марки по соответствующему нормативному документу, а также условия и порядок заправки дублирующими (резервными) ГСМ и, при необходимости, зарубежными ГСМ
Подраздел «Демонтаж и монтаж» содержит порядок работ по демонтажу и монтажу, перечень приспособлений и инструментов, необходимых для отсоединения, снятия, обратной установки и присоединения сборочных единиц (деталей), меры предосторожности, перечень регулировочных работ после монтажа. Указание «Установку проводить в обратной последовательности» приводить не разрешается
Подраздел «Регулирование и испытание» содержит порядок работ, необходимых для регулирования (настройки) составной части изделия для получения требуемых технических характеристик и параметров
Подраздел «Осмотр и проверка» содержит порядок работ, необходимых для осуществления доступа к осматриваемой части изделия; виды и методы ее осмотра и проверки; порядок работ, необходимых для проведения технического освидетельствования составных частей изделия органами инспекции и надзора, а также оценки технического состояния составных частей изделия при определении необходимости отправки их в ремонт
Подраздел «Очистка и окраска» содержит порядок работ по очистке и подкраске составных частей изделия, условий их выполнения и перечень используемых инструментов, приспособлений и материалов
Подраздел «Консервация» содержит требования, аналогичные изложенным в 5.1.5.1.6
Часть «Текущий ремонт» содержит сведения, необходимые для организации и проведения текущего ремонта изделия и его составных частей в условиях эксплуатации, состоит из разделов:
- текущий ремонт изделия;
- текущий ремонт составных частей изделия.
Раздел «Текущий ремонт изделия» содержит подразделы:
- общие указания;
- меры безопасности.
Подраздел «Общие указания» содержит требования по проведению ремонта, методы ремонта, требования к квалификации персонала, описание и характеристики диагностических возможностей систем встроенного контроля, а также перечень составных частей изделия, текущий ремонт которых может быть осуществлен только в условиях ремонтных органов и описание и характеристики диагностических возможностей внешних средств диагностирования. При необходимости приводят схемы поиска последствий отказов и повреждений
Подраздел «Меры безопасности» содержит правила предосторожности, которые в соответствии с действующими нормативами должны быть соблюдены при проведении работ
Раздел «Текущий ремонт составных частей изделия» содержит указания по поиску и устранению последствий отказов и повреждений и применительно к каждой составной части изделия, текущий ремонт которых возможен при эксплуатации, состоит из подразделов:
- поиск последствий отказов и повреждений;
- устранение последствий отказов и повреждений.
Подраздел «Поиск последствий отказов и повреждений» содержит указания по последовательности и объему работ, необходимых для отыскания последствий отказов и повреждений
Подраздел «Устранение последствий отказов и повреждений» содержит указания о методах устранения последствий отказов и повреждений, а также перечень необходимых для этого средств измерения, инструмента и приспособлений. Подраздел рекомендуется оформлять в виде карты (см. приложение А).
Раздел «Текущий ремонт составных частей изделия» допускается на подразделы не разделять, а сведения излагать в виде таблицы 6.
В графе «Описание последствий отказов и повреждений» приводят описание последствий отказов и повреждений, записанных в порядке вероятности их появления, и, при необходимости, указывают внешние проявления и другие дополнительные признаки последствий отказов и повреждений.
В графе «Возможные причины» указывают, какая из составных частей изделия может отказать и быть повреждена и возможные причины отказов и повреждений. Причины отказов и повреждений перечисляют в порядке вероятности появления.
В графе «Указания по установлению последствий отказов и повреждений сборочной единицы (детали)» приводят последовательность действий и другие указания, необходимые для установления (отыскания) последствий отказов и повреждений сборочной единицы (детали).
В графе «Указания по устранению последствий отказов и повреждений» перечисляют указания по устранению последствий отказов и повреждений или приводят ссылки на другие документы, по которым проводят работы по их устранению.
При необходимости перечень наиболее вероятных последствий отказов и повреждений может быть выделен в самостоятельную таблицу
Часть «Хранение» содержит:
- правила постановки изделия на хранение и снятия его с хранения;
- перечень составных частей изделия с ограниченными сроками хранения;
- перечень работ, правила их проведения, меры безопасности при подготовке изделия к хранению, при кратковременном и длительном хранении изделия, при снятии изделия с хранения;
- условия хранения изделия (вид хранилищ, температура, влажность, освещенность и т. п.) для определенных сроков хранения;
- способы утилизации (если изделие представляет опасность для жизни, здоровья людей или окружающей среды после окончания срока эксплуатации;
- предельные сроки хранения в различных климатических условиях.
Часть «Транспортирование» содержит:
требования к транспортированию изделия и условиям, при которых оно должно осуществляться;
порядок подготовки изделия для транспортирования различными видами транспорта;
способы крепления изделия для транспортирования его различными видами транспорта с приведением необходимых схем крепления;
порядок погрузки и выгрузки изделия и меры предосторожности.
Одновременно в разделе приводят транспортные характеристики изделия (масса, габаритные размеры, положение центра тяжести и т. п.), а также схему изделия применительно к расположению его на транспортном средстве с указанием основных размеров изделия. При необходимости указывают сведения по буксированию изделия и эвакуации
Часть «Утилизация» содержит:
- меры безопасности;
- сведения и проводимые мероприятия по подготовке и отправке изделия на утилизацию;
- перечень утилизируемых составных частей (расчетный);
- перечень утилизируемых составных частей, выявляемых по результатам текущего ремонта, технического обслуживания и хранения (при необходимости);
- методы утилизации, если изделие представляет опасность для жизни, здоровья людей и окружающей среды после окончания срока службы (эксплуатации).
Тематики
- проектирование, документация
EN
- application guide
- engineering instruction
- guide to operations
- handling manual
- instruction book
- maintenance guide
- maintenance manual
- operating guide
- operating instructions manual
- operating manual
- operations manual
- operator’s manual
- operators manual
- performance manual
- service instruction
- service manual
- user handbook
- user manual
- working instruction
Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.
Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».
Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».
Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).
Разделы руководства пользователя:
- Введение.
- Назначение и условия применения.
- Подготовка к работе.
- Описание операций.
- Аварийные ситуации.
- Рекомендации по освоению.
1. Введение
В разделе «Введение» указывают:
- область применения;
- краткое описание возможностей;
- уровень подготовки пользователя;
- перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.
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
В разделе «Назначение и условия применения» указывают:
- виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
- условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).
Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.
Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.
Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.
3. Подготовка к работе
В разделе «Подготовка к работе» указывают:
- состав и содержание дистрибутивного носителя данных;
- порядок загрузки данных и программ;
- порядок проверки работоспособности.
3.1. Состав и содержание дистрибутивного носителя данных
Для работы с ИАС КХД необходимо следующее программное обеспечение:
- Internet Explorer (входит в состав операционной системы Windows);
- Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.
3.2. Порядок загрузки данных и программ
Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:
- Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
- Во время загрузки в появившемся окне «Предупреждение о безопасности», которое будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator» …’ Нажимаем на кнопку «Да».
- После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.
3.3. Порядок проверки работоспособности
Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:
- Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
- Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
- В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
- Убедиться, что в окне открылось приложение Oracle Discoverer Plus.
В случае если приложение Oracle Discoverer Plus не запускается, то следует обратиться в службу поддержки.
4. Описание операций
В разделе «Описание операций» указывают:
- описание всех выполняемых функций, задач, комплексов задач, процедур;
- описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
Для каждой операции обработки данных указывают:
- наименование;
- условия, при соблюдении которых возможно выполнение операции;
- подготовительные действия;
- основные действия в требуемой последовательности;
- заключительные действия;
- ресурсы, расходуемые на операцию.
В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях.
4.1. Выполняемые функции и задачи
Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
| Функции | Задачи | Описание |
|---|---|---|
| Обеспечивает многомерный анализа в табличной и графической формах | Визуализация отчетности | В ходе выполнения данной задачи пользователю системы предоставляется возможность работы с выбранным отчетом из состава преднастроенных. |
| Формирование табличных и графических форм отчетности | В ходе выполнения данной задачи пользователю системы предоставляется возможность формирования собственного отчета в табличном или графическом виде на базе преднастроенных компонентов. |
4.2. Описание операций технологического процесса обработки данных, необходимых для выполнения задач
Ниже приведено описание пользовательских операций для выполнения каждой из задач.
Задача: «Визуализация отчетности»
Операция 1: Регистрация на портале ИАС КХД
Условия, при соблюдении которых возможно выполнение операции:
- Компьютер пользователя подключен к корпоративной сети.
- Портал ИАС КХД доступен.
- ИАС КХД функционирует в штатном режиме.
Подготовительные действия:
На компьютере пользователя необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего документа.
Основные действия в требуемой последовательности:
- На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
- В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».
Заключительные действия:
Не требуются.
Ресурсы, расходуемые на операцию:
15-30 секунд.
Операция 2: Выбор отчета
Условия, при соблюдении которых возможно выполнение операции:
Успешная регистрация на Портале ИАС КХД.
Подготовительные действия:
Не требуются.
Основные действия в требуемой последовательности:
1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».
2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:
Заключительные действия:
После завершения работы с отчетом необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».
Ресурсы, расходуемые на операцию:
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. настоящего документа.