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

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

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

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

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

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

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

1. Введение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Снова здравствуй, уважаемый хабралюд!

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

Всем, кому интересно, прошу под хабракат.

KISS

Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.

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

1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!

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

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

Clear screen/clear desk

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

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

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

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

14.11.2019

Руководство по эксплуатации оборудования для получения сертификата и/или декларации соответствия

Проанализировав Поиск Яндекса и Google — поисковая система, кроме платной разработки (цены от 4500 до 8000 рублей) руководство по эксплуатации нету никакой альтернативы сделать бесплатно этот документ. Исправляем эту ситуацию. Выкладываем пример руководство по эксплуатации для самостоятельного составления этого документа. Нужно подставить свои параметры оборудования и готово.

ООО «ХХХХХХХХХ» 

НАМЕНОВАНИЕ ПРОДУКЦИИ

«ХХХХХХХХХХХХХ« 

РУКОВОДСТВО ПО ЭКСПЛУАТАЦИИ 

20ХХ

СОДЕРЖАНИЕ

ВВЕДЕНИЕ

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

1. НАЗНАЧЕНИЕ, ОСНОВНЫЕ ТЕХНИЧЕСКИЕ ДАННЫЕ, КОНСТРУКТИВНОЕ ИСПОЛНЕНИЕ

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

2. КОМПЛЕКТНОСТЬ

Поставляемая продукция должна сопровождаться документом, подтверждающим ее качество (паспортом) и инструкцией по эксплуатации, соответствующей требованиям ГОСТ 2.601. Комплектность поставки изделия должна соответствовать условиям договора (заказа) и спецификации по согласованию с заказчиком. Оборудование согласно заказа поставляется полностью собранной, в комплекте с узлами и деталями. Перечень основного технологического оборудования приведен в таблице 11.

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

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

Вам будет интересно

Перейти на главную блога