Чем отличается руководство по эксплуатации от инструкции по эксплуатации

1. Понятие руководства по эксплуатации

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

Навигация по странице:

1. Понятие руководства по эксплуатации
2. Статус руководства по эксплуатации в ряду прочих технических документов
3. Области применения руководства по эксплуатации
4. Дополнительные сферы применения РЭ

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

Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.

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

Статус руководства по эксплуатации в ряду прочих технических документов

ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».

Картинка с сайта: www.centrattek.ru

Требования ГОСТ 2.601-2006 устанавливают, что разработка руководства по эксплуатации не носит обязательного характера в отношении всех без исключения видов изделий: необходимость формирования этого документа определяется самим создателем продукции с учетом сложности его использования, необходимости применения дополнительной информации для корректной настройки и применения и других факторов. При этом в данном нормативно-правовом документе имеется оговорка о том, что в случае, если разработка конкретного продукта производится по заказу Министерства обороны РФ, именно это ведомство будет выступать в качестве органа, принимающего решение о необходимости разработки руководства по эксплуатации (РЭ).

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

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

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

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

Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.

• Главная
• Статьи

Разработка и оформление руководства по эксплуатации

РАЗРАБОТКА И ОФОРМЛЕНИЕ
РУКОВОДСТВА ПО ЭКСПЛУАТАЦИИ

ЧТО ТАКОЕ ИНСТРУКЦИЯ ПО ЭКСПЛУАТАЦИИ?

Руководство по эксплуатации (РЭ) – это эксплуатационный документ (ЭД), прилагаемый к технически сложным изделиям. Второе название руководства по эксплуатации – это инструкция, однако если рассмотреть терминологию по ГОСТ 2.601-2006, то между этими определениями есть разница. Дело в том, что РЭ – это полная разработка по эксплуатации оборудования, машин, приборов, захватывающая практически все сведения о продукте. В документ включается информация о конструкции, принципе действия, комплектующих, указания по использованию, ремонту и хранению, а также об утилизации. В свою очередь инструкция представляет собой ЭД более узкой направленности, в котором указываются только рекомендации по монтажу изделия и пусконаладочным работам. Поэтому, когда установка и запуск устройств будет проводиться персоналом (или потребителями в случае использования бытовых приборов), то такие сведения размещаются в руководстве по эксплуатации, в остальных случаях – в инструкции. Кроме того, иногда возникают ситуации, при которых разрабатываются отдельная специальная инструкция, например, для уменьшения объема РЭ (переноса из него информации). Зачастую так происходит с разделами по мерам безопасности, по поверке приборов и так далее.

Картинка с сайта: csartel.ru

ГДЕ ОБЯЗАТЕЛЬНА ИНСТРУКЦИЯ ПО ЭКСПЛУАТАЦИИ?

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

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

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

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

Еще одним примером может служить технический регламент № 016/2011, который указывает, что в комплект поставки газоиспользующего оборудования должны входит ЭД, состоящие из инструкции по монтажу и руководства по эксплуатации. К такой продукции, относятся, например, приборы, предназначенные для приготовления пищи, блочные автоматические горелки и другие.

ОФОРМЛЕНИЕ РУКОВОДСТВА ПО ЭКСПЛУАТАЦИИ

Уточнить, обязательно ли делать руководство по эксплуатации именно для вашей продукции, вы можете в нашем центре сертификации (ЦС). Поскольку здесь предоставляется полный комплекс услуг по разработке документов, в том числе и РЭ.

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

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

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

ТРЕБОВАНИЯ К РУКОВОДСТВУ ПО ЭКСПЛУАТАЦИИ

СКОЛЬКО СТОИТ СЕРТИФИКАТ «БЕЗ ГМО»?

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

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

ОТЗЫВЫ И РЕКОМЕНДАЦИИ НАШИХ КЛИЕНТОВ

Картинка с сайта: csartel.ru

Компания «Байкал»

Начальник отдела сбыта Кудряшова Валерия

Здравствуйте. Меня зовут Валерия, я являюсь представителем компании «Байкал». Наша продукция периодически требует подтверждения соответствия и в прошлом году нам посоветовали Центр сертификации «Апрель». Работают качественно, быстро и для нас менее затратно. И эту компанию мы советуем своим партнерам. Спасибо за внимание.

Картинка с сайта: csartel.ru

ООО «Лидер»

Старший технолог Авдеенко Елена

Здравствуйте. Меня зовут Елена. Наша компания «Лидер» полгода назад обратилась в компанию «Апрель» за сертификацией нашего предприятия. Изучая многие организации, лучшими условия оказались именно у них. Сам процесс прошел легко, нам указали на ошибки, помогли их исправить. Сообщили также много полезной информации о предстоящих изменениях. Апрель одна из немногих, кто на деле предоставляет индивидуальные условия работы с клиентом. Работой мы оказались довольны. Также, планируем работать с ними дальше и еще рекомендуем их нашим партнерам.

Картинка с сайта: csartel.ru

Фабрика «Три коржа»

Заместитель директора Толокольникова Алёна

Здравствуйте, меня зовут Алёна. Я представляю частного предпринимателя Грушенцову. На самом деле хотелось посоветовать вам Центр сертификации «Апрель». С ним мы сотрудничаем уже достаточно давно, если у нас возникает необходимость в сертификации, мы сразу обращаемся к ним. Во-первых, это очень удобно, это экономит время, так как весь процесс они берут на себя. От нас требуется только согласование, это очень экономит время, на самом деле. Во-вторых они очень хорошо консультируют, всегда подскажут где можно сэкономить, на что обратить внимание. Так как мы не специалисты в этом деле для нас это очень важно. Поэтому рекомендуем поработать с ними, не пожалеете, сэкономите свое время, нервы иденьги. Спасибо.

Картинка с сайта: csartel.ru

ООО «Регион»

Директор Исупова Светлана Юрьевна

Здравствуйте. Меня зовут Светлана. Наша компания «Регион» узнала о Центре сертификации «Апрель» по рекомендации наших компаньонов. Заказали в «Апреле» разработку технической документации. Быстрая реакция на заказ, соблюдение сроков, для нас это явилось важным фактором оценки работы Центра «Апрель». С тех пор периодически обращаемся в «Апрель». Компетентные специалисты этого центра профессионально выполняют свою работу. Теперь и мы можем со всей ответственностью и уверенностью порекомендовать Центр сертификации «Апрель».

Картинка с сайта: csartel.ru

ООО «Горные системы»

Директор Орлов Никита Владимирович

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

Картинка с сайта: csartel.ru

ФГУП Владимирское ФСИН

Логист Крючков Антон Геннадьевич

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

Благодарности Наших клиентов

Часто задаваемые вопросы

Разработка технической документации

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

Разрабатываем техническую документацию на изделие:

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

Техническая документация — составная часть конструкторской документации, выполняемой по ЕСКД и в полном объеме.

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

1. В случае разработки и изготовления нового изделия. Техдокументация в комплекте с чертежами на выпускаемое изделие передается заказчику.

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

3. В случае ввоза изделия из зарубежа и его растамаживания.

4. В случае, если изделие представляет собой комплекс из составных покупных изделий, но поставляется как новое изделие заказчику на территории России. В этом случае требуются подтверждающие документы, что изделие было произведено (или собрано) на территории РФ. Такими документами и служит паспорт на изделие, включающий в себя габаритные чертежи.

Руководство по эксплуатации (РЭ)

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

Обязательные разделы РЭ:

• Введение
• Описание и работа.
• Использование по назначению.
• Техническое обслуживание.
• Текущий ремонт.
• Хранение.
• Транспортирование.
• Утилизация.

Паспорт на изделие

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

Паспорт на техническое устройство разрабатывается согласно ГОСТ 2.610-2006 и содержит следующие обязательные разделы:

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

Чем отличается паспорт и руководство по эксплуатации

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

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

Но очень во многом эти два документа дублируют друг друга, поэтому ГОСТом допускается совмещать паспорт и руководство по эксплуатации в одном документе. При этом на титульном листе так и пишут: «Паспорт и руководство по эксплуатации».

Источник

Эксплуатационные документы: руководство по эксплуатации

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

Навигация по странице:

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

Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.

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

Статус руководства по эксплуатации в ряду прочих технических документов

ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».

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

Требования ГОСТ 2.601-2006 устанавливают, что разработка руководства по эксплуатации не носит обязательного характера в отношении всех без исключения видов изделий: необходимость формирования этого документа определяется самим создателем продукции с учетом сложности его использования, необходимости применения дополнительной информации для корректной настройки и применения и других факторов. При этом в данном нормативно-правовом документе имеется оговорка о том, что в случае, если разработка конкретного продукта производится по заказу Министерства обороны РФ, именно это ведомство будет выступать в качестве органа, принимающего решение о необходимости разработки руководства по эксплуатации (РЭ).

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

Дополнительные сферы применения РЭ

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

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

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

Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.

Источник

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

Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.

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

Содержание

Содержание

Типичное руководство пользователя содержит:

• Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение
• Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство
• Страницу содержания
• Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы
• Глава, описывающая возможные проблемы и пути их решения
• Часто задаваемые вопросы и ответы на них
• Где ещё найти информацию по предмету, контактная информация
• Глоссарий и, в больших документах, предметный указатель

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

Стандарты

Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

• Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
  • РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
• Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:
  • ГОСТ 2.601-2006 Эксплуатационные документы
  • ГОСТ 2.610-2006 Правила выполнения эксплуатационных документов
• Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:
  • ГОСТ 19.101-77 Виды программ и программных документов
  • ГОСТ 19.105-78 Общие требования к программным документам
  • ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
  • ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению

См. также

Ссылки

• Руководство пользователя. Пример оформления по РД 50-34.698-90
• Бесплатные инструкции по эксплуатации бытовой электроники
• Как писать руководство пользователя? Часть I
• Как писать руководство пользователя? Часть II
• Сайт разработчиков технической документации (технических писателей)

• MetaGuide — руководство для разработчиков технической документации к программному обеспечению
• Типичные ошибки в справке пользователя для ПО и как их избежать
• Руководства по ремонту автомобилей
• Руководства по эксплуатации автомобильной техники
• Руководства по эксплуатации бытовой техники

Wikimedia Foundation . 2010 .

Смотреть что такое «Руководство пользователя» в других словарях:

руководство пользователя — сущ., кол во синонимов: 4 • инструкция (28) • мануалка (5) • паспорт (17) • … Словарь синонимов

руководство пользователя — — [Е.С.Алексеев, А.А.Мячев. Англо русский толковый словарь по системотехнике ЭВМ. Москва 1993] Тематики информационные технологии в целом EN user guidemanual … Справочник технического переводчика

руководство пользователя — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

руководство пользователя по аккредитации и подаче заявок на Олимпийские игры — [Департамент лингвистических услуг Оргкомитета «Сочи 2014». Глоссарий терминов] Тематики спорт (службы Игр) EN accreditation and entries at the Olympic Games users guide … Справочник технического переводчика

Руководство — Руководство: Руководство контроль поведения других людей (см. Власть). Руководство набор правил для осуществления или использования чего либо (см. Инструкция). См. также Руководство пользователя Организационное руководство Руководство … Википедия

руководство для пользователя — — [А.С.Гольдберг. Англо русский энергетический словарь. 2006 г.] Тематики энергетика в целом EN user directory … Справочник технического переводчика

руководство для пользователя — vartotojo instrukcija statusas T sritis automatika atitikmenys: angl. user guide; user manual vok. Benutzeranleitung, f; Benutzerhandbuch, n rus. руководство для пользователя, n pranc. notice de présentation, f … Automatikos terminų žodynas

РУКОВОДСТВО ПО РАЗРАБОТКЕ БЮДЖЕТА — BUDGET MANUALРазработка бюджета может быть упрощена до определенной степени, если у фирмы имеется руководство по разработке бюджета, к рое документирует процедуру разработки и определяет основные направления, к рым необходимо следовать на… … Энциклопедия банковского дела и финансов

справочник пользователя — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

Р 50.1.041-2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации-пользователя — Терминология Р 50.1.041 2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации пользователя: 3.1.1 аккредитованная организация разработчик стандартов (accredited standards development… … Словарь-справочник терминов нормативно-технической документации

Источник

Руководство пользователя. Советы для составления

Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

Картинка с сайта: instruk.detektorpoligraf.ru

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

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

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

1. Стандарты

Часто бывает нужно написать документ, который бы удовлетворял требованиям действующих стандартов. Это могут быть:

• IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
• ГОСТ 19:
  • ГОСТ 19.402-78 ЕСПД. Описание программы;
  • ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

Также может оказаться полезной книга Юрия Кагарлицкого MetaGuide. Руководство для разработчиков технической документации к программному обеспечению.

2. Структура

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

Хорошее руководство пользователя должно содержать:

• Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение. Также рекомендуется писать краткую аннотацию в начале каждого крупного раздела.
• Введение, содержащее информацию о том, как лучше всего использовать данное руководство
• Содержание
• Главы, описывающие, как использовать ПО
• Глоссарий и
• Предметный указатель

Также руководство пользователя может содержать:

• FAQ и ответы на них
• Ссылки на дополнительную информацию по системе
• Раздел, описывающий возможные проблемы и пути их решения

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

3. Пользователи

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

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

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

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

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо: In File menu, select Save item.
Хуже: Select Save item from File menu.

4.2 Используйте повелительное наклонение, не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо: Click Logout to log out current user account from the system.

Хуже: It is needed to click Logout to log out current user account from the system.

Хуже: If user wants to log out current user account from the system (s)he needs to click Logout.

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

Хорошо:
To create project:

1. Click the Create button on toolbar.
2. On the CreateProject overlay fill in all mandatory fields.
3. Click the Savebutton to save the project.

Хуже: To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время. Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо: When user clicks the Start button, the program starts the process.

Хуже: When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

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

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон.

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

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

5. Внешний вид

5.1 Продумайте стиль документа. Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

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

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

6. Поддержка

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

Заключение

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

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества analyst.by,

Источник

Паспорт и руководство по эксплуатации

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

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

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

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

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

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

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

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

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

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

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

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

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

Источник