ГОСТ IEC 82079-1-2014
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
ПОДГОТОВКА ИНСТРУКЦИЙ ПО ПРИМЕНЕНИЮ
Построение, содержание и представление материала
Часть 1
Общие принципы и подробные требования
Preparation of instructions for use. Structuring, content and presentation International. Part 1. General principles and detailed requirements
МКС 01.110
29.020
Дата введения 2015-10-01
Предисловие
Цели, основные принципы и общие правила проведения работ по межгосударственной стандартизации установлены ГОСТ 1.0 "Межгосударственная система стандартизации. Основные положения" и ГОСТ 1.2 "Межгосударственная система стандартизации. Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации. Правила разработки, принятия, обновления и отмены"
Сведения о стандарте
1 ПОДГОТОВЛЕН Открытым акционерным обществом "Всероссийский научно-исследовательский институт сертификации" (ОАО "ВНИИС") на основе собственного перевода на русский язык англоязычной версии стандарта, указанного в пункте 5
2 ВНЕСЕН Федеральным агентством по техническому регулированию и метрологии
3 ПРИНЯТ Межгосударственным советом по стандартизации, метрологии и сертификации (протокол от 30 сентября 2014 г. N 70-П)
За принятие проголосовали:
Краткое наименование страны по МК (ИСО 3166) 004-97 | Код страны по МК (ИСО 3166) 004-97 | Сокращенное наименование национального органа по стандартизации |
Армения | AM | Минэкономики Республики Армения |
Беларусь | BY | Госстандарт Республики Беларусь |
Киргизия | KG | Кыргызстандарт |
Молдова | MD | Молдова-Стандарт |
Россия | RU | Росстандарт |
4 Приказом Федерального агентства по техническому регулированию и метрологии от 24 ноября 2014 г. N 1723-ст межгосударственный стандарт ГОСТ IEC 82079-1-2014 введен в действие в качестве национального стандарта Российской Федерации с 1 октября 2015 г.
5 Настоящий стандарт идентичен международному стандарту IEC 82079-1:2012* "Подготовка инструкций по применению. Структурирование, содержание и представление. Часть 1. Общие принципы и подробные требования" ("Preparation of instructions for use - Structuring, content and presentation international - Part 1: General principles and detailed requirements", IDT).
___________________________
* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей. - .
Международный стандарт разработан Техническим комитетом 3 "Структура информации, документация и графические символы" Международной электротехнической комиссии (IEC).
В разделе "Нормативные ссылки" ссылки на международные стандарты актуализированы.
При применении настоящего стандарта рекомендуется использовать вместо ссылочных международных стандартов соответствующие им межгосударственные стандарты, сведения о которых приведены в дополнительном приложении ДА
6 ВВЕДЕН ВПЕРВЫЕ
7 ПЕРЕИЗДАНИЕ. Сентябрь 2020 г.
Информация о введении в действие (прекращении действия) настоящего стандарта и изменений к нему на территории указанных выше государств публикуется в указателях национальных стандартов, издаваемых в этих государствах, а также в сети Интернет на сайтах соответствующих национальных органов по стандартизации.
В случае пересмотра, изменения или отмены настоящего стандарта соответствующая информация будет опубликована на официальном интернет-сайте Межгосударственного совета по стандартизации, метрологии и сертификации в каталоге "Межгосударственные стандарты"
1 Область применения
Настоящий стандарт устанавливает общие принципы и подробные требования к проектированию и разработке всех видов инструкций по применению, которые будут необходимы или полезны для пользователей продукции любого вида, начиная от банки с краской до больших или очень сложных изделий, таких как крупные промышленные машины, заводы или строения, поставляемые под ключ.
Примечание - Термин "продукт", как определено в 3.29 настоящего стандарта, относится к потребительским непродовольственным, электрическим, электронным, электромеханическим, механическим и другим изделиям.
Стандарт предназначен в качестве руководства всем заинтересованным сторонам, участвующим в подготовке инструкций по применению, например:
поставщикам, составителям технических документов, иллюстраторам технических документов, разработчикам программного обеспечения, переводчикам и другим специалистам, занятым работой по планированию и составлению инструкций по применению.
Стандарт не устанавливает количественных характеристик документации, которая должна быть поставлена с изделием. Это, очевидно, невозможно, так как настоящий стандарт применим ко всем видам продукции. Требуемые количественные характеристики документации будут зависеть от характера изделия, его сложности и навыков предполагаемых пользователей.
2 Нормативные ссылки
В настоящем стандарте использованы нормативные ссылки на следующие стандарты. Для датированных ссылок применяют только указанное издание ссылочного стандарта, для недатированных - последнее издание (включая все изменения).
IEC 60204-1:2005, Safely of machinery - Electrical equipment of machines - Part 1: General requirements (Безопасность машин. Электрооборудование машин. Часть 1. Общие требования)
_______________
IEC 60417, Graphical symbols for use on equipment (Графические символы, наносимые на оборудование)
IEC 60529, Degrees of protection provided by enclosures (IP Code) (Степени защиты, обеспечиваемые оболочками (код IP))
IEC 60617, Graphical symbols for diagrams (Графические символы для схем)
IEC 62507-1, Identification systems enabling unambiguous information interchange - Requirements - Part 1: Principles and methods (Системы идентификации, способные на недвусмысленный обмен информацией. Требования. Часть 1. Принципы и методы)
IEC/PAS 62569-1:2009, Generic specification of information on products - Part 1: Principles and methods (Общая техническая информация о продукции. Часть 1. Принципы и методы)
_______________
ISO 3864 (all parts), Graphical symbols - Safety colours and safety signs [(все части). Графические символы. Сигнальные цвета и знаки безопасности)]
ISO 3864-2, Graphical symbols - Safety colours and safety signs - Part 2: Design principles for product safety labels (Графические символы. Сигнальные цвета и знаки безопасности. Часть 2. Принципы проектирования для этикеток безопасности продукции)
ISO 7000, Graphical symbols for use on equipment - Index and synopsis (Графические символы, наносимые на оборудование. Указатель и краткое изложение)
ISO 7010, Graphical symbols - Safety colours and safety signs - Registered safety signs (Графические символы. Сигнальные цвета и знаки безопасности. Зарегистрированные знаки безопасности)
ISO 9241 (all parts), Ergonomics of human-system interaction [(все части). Эргономика взаимодействия "человек-система")]
ISO 11683, Packaging - Tactile warnings of danger - Requirements (Упаковка. Тактильные предупреждения об опасности. Требования)
ISO 12100, Safety of machinery - General principles for design - Risk assessment and risk reduction (Безопасность машин. Основные принципы дизайна. Оценка рисков и снижение рисков)
ISO 14617 (all parts), Graphical symbols for diagrams [(все части). Графические символы для схем)]
ISO/IEC Guide 51:1999, Safety aspects - Guidelines for their inclusion in standards (Аспекты безопасности. Правила включения в стандарты)
_______________
ISO/IEC Guide 71:2001, Guidelines for standards developers to address the needs of older persons and persons with disabilities (Руководящие указания для разработчиков стандартов, направленных на удовлетворение потребностей пожилых людей и лиц с ограниченными возможностями)
_______________
3 Термины и определения
В настоящем стандарте применены следующие термины с соответствующими определениями.
Примечание - Термины, выделенные курсивом, определены в другом пункте настоящего раздела.
3.1 продукт общедоступного дизайна (accessible design product): Продукт, который предназначен для максимального числа потенциальных пользователей.
3.2 шрифт Брайля (braille): Система письма, использующая ряд двумерных моделей выпуклых точек для чтения с помощью пальцев.
3.3 ввод в действие (commissioning): Процедуры, предшествующие или связанные с ними, передаче продукта, готового к вводу в эксплуатацию, в том числе окончательные приемочные испытания, передача всех документов, имеющих отношение к использованию продукта и, при необходимости, инструктаж персонала.
3.4 компонент (component): Продукт, используемый в качестве составной части собранного продукта, системы или установки.
[IEC 81346-1:2009, определение 3.7]
3.5 соответствия (conformity): Выполнение установленных требований.
Примечание - Термин "conformance (согласование)" является синонимом, но не рекомендуется.
3.6 последствие (consequence): Результат определенного стечения обстоятельств.
Примечание 1 - От одного события может быть более одного последствия.
Примечание 2 - Последствия могут варьировать от положительных к отрицательным. Однако последствия, не следующие требованиям безопасности, всегда будут отрицательными.
Примечание 3 - Последствия могут быть выражены качественно или количественно.
[ISO Guide 73:2009, 3.6.1.3, модифицировано]
3.7 расходный материал (consumable): Любая порция материала, которая необходима для дальнейшего использования или обслуживания продукта.
3.8 потребитель (consumer): Отдельно взятый представитель широкой публики, приобретающий или использующий продукцию, имущество или услуги в личных целях.
Примечание - Исходя из требований настоящего стандарта предполагается, что "потребитель" не должен быть квалифицированным лицом.
3.9 потребительский продукт (consumer product): Продукт, доступный или предназначенный для использования потребителем.
Примечание - Потребительская продукция подразумевает наличие у продукции общедоступного дизайна.
3.10 клиент (customer): Лицо или организация, которые приобретают или получают продукт.
Примечание 1 - Примерами являются потребитель, заказчик, конечный пользователь, розничный торговец, бенефициар и покупатель.
Примечание 2 - Термин "клиент" включает понятие "потребитель", но имеет более широкое по сравнению с ним значение.
[ISO 9000:2005, 3.3.5, модифицировано]
3.11 дисплей (display): Устройство, поставляемое как часть продукта с целью визуального или осязаемого представления текста или графика в виде информации, доступной человеческому пониманию.
3.12 документ (document): Фиксированный и структурированный объем информации, предназначенной для восприятия человеком, которым можно управлять и обмениваться как единым целым между пользователями и системой.
[IEC 61082-1:2006, определение 3.1.2]
3.13 документация (documentation): Сборник документов, относящихся к данной теме.
[IEC 61082-1:2006, 3.1.4]
3.14 оборудование (equipment): Взаимосвязанные устройства, предназначенные для достижения определенной конечной цели.
3.15 графический символ (graphical symbol): Визуально различимая фигура с особым смысловым значением, используемая для передачи информации независимо от языка.
[IEC 80416-1:2008, 3.4]
3.16 вред (harm): Телесные повреждения или ущерб здоровью людей или ущерб имуществу или окружающей среде.
[ISO/IEC Guide 51:1999, 3.3]
3.17 опасность (hazard): Потенциальный источник вреда.
[ISO/IEC Guide 51:1999, 3.5]
3.18 иллюстрация (illustration): Визуально воспринимаемое изображение, например, графический образ, картина, рисунок, фотография, рисунок карандашом и т.д., искусственно созданное для передачи определенной информации, за исключением графических символов.
3.19 инструкции по применению (instructions for use): Информация, предоставленная поставщиком продукта пользователю, содержащая все необходимые положения, характеризующие действия, подлежащие выполнению для безопасного и эффективного использования продукта.
Примечание - Инструкции по применению одного продукта включают один или несколько документов.
[ISO/IEC Guide 14:2003, 2.8, модифицировано]
3.20 применение по назначению (intended use): Исчерпывающий диапазон функций или предусмотренных приложений, определенных и воплощенных в конструкцию поставщиком продукта.
Примечание 1 - Функции или приложения, не перечисленные поставщиком, исключаются из предполагаемого использования продукта.
Примечание 2 - Дополнительные или измененные функции или приложения в результате модификации, не санкционированной изготовителем продукта, исключаются из предполагаемого использования.
3.21 этикетке* (label): Табличка, прикрепленная к продукту, отображающая информацию, относящуюся к одной или более характеристикам продукта.
________________
* Текст документа соответствует оригиналу. - .
[ISO/IEC Guide 14:2003, 2.9]
3.22 техническое обслуживание (maintenance): Действия, предназначенные для поддержания функционирования продукта или для его восстановления в полезное и безопасное состояние, соответствующее применению по назначению.
3.23 руководство (manual): Документ, содержащий информацию по использованию продукта.
Примечание - Определение D00014 в IEC 61355 определяет тип документа в виде "Руководство XXX", где буквы XXX призваны обозначить тип руководства.
3.24 маркировка (marking): Логотип, надпись, графический символ, пиктограмма, тактильный индикатор, предупреждающий знак на продукте, нанесенные с целью идентификации его типа или как указание.
Примечание - Маркировка может также включать короткие текстовые сообщения.
[ISO/IEC Guide 14:2003, 2.4, модифицировано]
3.25 модификация (modification): Изменения, внесенные в продукт для того, чтобы изменить его применение по назначению.
3.26 организация (organization): Группа лиц и необходимых средств с распределением ответственности, полномочий и взаимоотношений.
Примеры: компания, корпорация, фирма, предприятие, учреждение, благотворительная организация, предприятие розничной торговли, ассоциация или их части или комбинации.
Примечание - Организация может быть государственной или частной.
[ISO 9000:2005, 3.3.1, модифицировано]
3.27 средство индивидуальной защиты (personal protective equipment): Специальное устройство или прибор, предназначенные для ношения или находящиеся отдельно, для защиты от одного или более видов опасности для здоровья и безопасности.
3.28 завод (plant): Сборка различных систем в указанном месте.
[IEC 61355-1:2008, 3.10]
3.29 продукт (product): Замышленный или завершенный результат труда или естественного или искусственного процесса, который может оказать пользу или услугу.
Примечание - Инструкции по применению рассматривают как часть продукта.
3.30 этикетка безопасности продукта (product safety label): Этикетка на продукте, информирующая наблюдателя об одной или нескольких потенциальных опасностей и описывающая меры предосторожности и/или действия, необходимые для предотвращения опасности(ей).
[ISO 17724:2003, 3.58]
3.31 обоснованно прогнозируемое неправильное применение (reasonably foreseeable misuse): Использование продукта способами, не предусмотренными в качестве применения по назначению в инструкциях по применению, но которые могут иметь место в результате легкопредсказуемого поведения человека.
[ISO/IEC Guide 51:1999, 3.14, модифицировано]
3.32 ремонт (repair): Часть внепланового технического обслуживания, при котором действия выполняются на изделии с заменой изношенных деталей и исправлением вышедших из строя или поврежденных частей или функций.
3.33 риск (risk): Сочетание вероятности причинения вреда и тяжести этого вреда.
[ISO/IEC Guide 51:1999, 3.2]
3.34 указание по безопасности (safety note): Относящаяся к безопасности информация, собранная или сгруппированная в виде документа или раздела документа в виде значимой организационной системы с целью объяснения мер безопасности, повышения безопасности населения и обеспечения основы для обучения пользователей по вопросам безопасности.
3.35 знак безопасности (safety sign): Знак, призванный дать общее сообщение по безопасности, полученный сочетанием цвета и геометрической формы и который при добавлении графического символа дает определенное сообщение по безопасности.
[ISO 7010:2011, определение 3.3]
3.36 сервис (service): Результат деятельности между поставщиком и клиентом, и внутренняя деятельность, осуществляемая поставщиком в соответствии с требованиями клиента.
[ISO/IEC Guide 14:2003, 2.2, модифицировано]
3.37 специалист (skilled person): Лицо с соответствующим техническим образованием, профессиональная подготовка и/или опыт которого позволяют ему прогнозировать риски и избегать опасностей, возникающих во время использования продукта.
[IEC 195-04-01, модифицировано и IEC 60204-1:2005, 3,53*, модифицировано]
________________
* Текст документа соответствует оригиналу. - .
3.38 прилагаемый аксессуар (supplied accessory): Часть в комплекте с продуктом (или как дополнительная опция), необходимая для выполнения определенных операций или обслуживания продукта.
3.39 поставщик (supplier): Лицо или организация, поставляющие продукцию и соответствующую документацию.
Примечание - Примерами поставщиков являются производитель, изготовитель, интегратор, торговец в разнос, дистрибьютор, розничный торговец, агентство, поставщик информации или их уполномоченные представители.
[ISO/IEC Guide 14:2003, 2.16, модифицировано и ISO 9000:2005, 3.3.6, модифицировано]
3.40 целевая группа (target group): Группа лиц, для которых предназначены инструкции по применению.
3.41 применение (use): Действия, которые пользователь может выполнять с данным продуктом в течение его полного жизненного цикла.
3.42 пользователь (user): Лицо или организация, применяющие продукцию.
Примечание - В настоящем стандарте термин "пользователь" означает "конечный пользователь", если не указано иное.
3.43 предупреждающее сообщение (warning message): Информации, относящаяся к безопасности, которая предупреждает пользователей о возможных опасностях и инструктирует, как их избежать.
Примечание - Предупреждающие сообщения обычно приводят в инструкциях по применению, увязывая с действиями, в которых может возникнуть опасность.
4 Принципы
4.1 Подготовка инструкций по применению
4.1.1 Общие положения
Уровень описания и подробности информации должны быть адаптированы к уровню знаний целевой группы (групп). Инструкция по применению должна обеспечить полноту соответствующей информации на достаточном уровне детализации на основе установленных потребностей целевой группы.
4.1.2 Инструкции по применению как часть продукта
Продукт должен сопровождаться инструкциями по применению, способствующими его применению по назначению и содержащими полную информацию о том, что пользователь должен знать при использовании продукта. Если инструкции по применению состоят более чем из одного документа, они должны быть должным образом систематизированы и поддержаны указателем поиска. Способ интегрирования документов третьих лиц должен основываться на требованиях заказчика и потребностях пользователя.
Инструкции по применению должны, при их соблюдении пользователем, способствовать снижению риска получения травмы или заболеваний людей и животных, а также риска повреждения, появления неисправности или неэффективной работы продукта. Инструкции по применению не могут компенсировать недостатки конструкции или отсутствие системы безопасности (см. ISO/IEC Guide 37).
4.1.3 Непротиворечивость информации
Вся информация в инструкциях по применению должна быть непротиворечивой по отношению к самой себе, к продукту и всякой иной информации, касающейся того же продукта, предоставленной поставщиком, такой как реклама или оформление упаковки и любая гарантийная информация и информация в интернете. Информация, содержащаяся в инструкциях по применению, не должна также противоречить любыми правовым требованиями, которые могут возникнуть в результате каких либо гарантийных оговорок. Непротиворечивость терминологии должна быть соблюдена в инструкциях по применению, на продукте и его упаковке, а также в дополнительных материалах, в любых учебных и рекламных материалах, включая маркировку, этикетки и транспортную тару.
4.1.4 Гарантийные обязательства
Гарантия на продукт должна включать все соответствующие условия (например, срок службы, условия эксплуатации, допустимые модификации, наличие запасных частей), и должна предоставляться вместе с инструкциями по применению.
Иногда может быть целесообразным оформить гарантию в виде отдельного документа, особенно когда условия меняются в зависимости от каналов продажи или стран.
4.1.5 Информация, представленная после продажи продукции
После того, как продукт перешел в собственность пользователя, может оказаться целесообразным предоставить пользователям и целевым группам, через Интернет на основе обмена сообщениями или через другие средства связи, контрольные копии инструкций по применению (включая любые последующие дополнения или изменения) и другую информацию, которая будет полезной для пользователя. Если критически важные изменения по вопросам безопасности внесены в инструкции по применению после реализации продукции, то для выполнения обязанностей поставщика в соответствии с местным законодательством, касающимся отзывов небезопасной продукции или ответственности изготовителя, пользователи должны быть проинформированы в индивидуальном порядке через дополнительное обновление версии на веб-сайте, или через средства массовой информации.
4.1.6 Аспекты безопасности
Включение аспектов безопасности должно осуществляться в соответствии с ISO/IEC Guide 81.
4.2 Качество передаваемой информации
За подготовку инструкции по применению, в том числе проверку и корректуру, должны нести ответственность эксперты-составители или специалисты. Они должны:
- обладать передовыми навыками общения, особенно техническими средствами связи;
- хорошо владеть языком оригинала;
- быть знакомыми с предметной областью;
- иметь знания по технологическому процессу подготовки инструкции по применению и обладать компетенцией в части применения требований настоящего стандарта в технологическом процессе.
Инструкции по применению должны быть контекстуально отредактированы квалифицированными лицами, специализирующимися в написании сообщений для целевых групп.
4.3 Минимизация рисков
Инструкции по применению являются неотъемлемой частью системы безопасной эксплуатации и обслуживания продукта. Они предназначены сообщать информацию, позволяющую предотвратить любую опасность для пользователя или других лиц, повреждения самого продукта или другой продукции, возникновение неисправности или неэффективной работы. Инструкции по применению должны предоставлять пользователям необходимую информацию, чтобы они сами могли определить опасность и сознательно избежать обоснованно прогнозируемого неправильного применения. Для этого требуется, чтобы поставщик продукта гарантировал следующее:
- оценка риска применения, то есть анализ процесса от анализа риска до оценки риска осуществляется поставщиком в соответствии с ISO 12100 и/или IEC 60204-1, если это применимо;
- результат оценки риска, то есть остаточный риск, должен быть принят во внимание в инструкции по применению в качестве информации о мерах обеспечения безопасности в соответствии с ISO/IEC Guide 51 и другими соответствующими стандартами по информации о мерах обеспечения безопасности;
- должны быть оценены обоснованно прогнозируемое неправильное применение и риски, связанные с использованием продукта.
См. также 5.5.
Примечание - Положение о том, что поставщик обязан включать информацию о мерах обеспечения безопасности, в действительности является правовым требованием в большинстве стран.
4.4 Целевая(ые) группа(ы)
При подготовке инструкции по применению должны быть адресно учтены потребности и возможности предполагаемой целевой группы. Обычно для характеристики людей, которые вероятно будут пользоваться продуктом, определяют, например, возрастной диапазон, язык, уровень технических знаний или технических дисциплин. См. также 4.8.2 и 4.8.3.
Если инструкции по применению ориентированы на несколько целевых групп (например, на потребителей и лиц, ответственных за монтаж, ремонт или определенные виды технического обслуживания), то они должны быть поделены на соответствующие разделы, которые ясно обозначены соответствующим образом. Целевые группы должны быть определены в начале изложения.
4.5 Особые меры предосторожности
Следует обращать внимание на необходимость специальных защитных мер, таких как контроль со стороны взрослых или ношение специальной одежды, необходимых для защиты пользователей и случайных зрителей.
Опасности для особо уязвимых групп населения, таких как дети, пожилые люди и инвалиды (в том числе, например, пользователи с кардиостимуляторами или страдающие аллергическими реакциями на конкретные химические вещества или чувствительные к эффекту стробоскопического освещения), также должны быть выделены (см. ISO/IEC 37 Guide и ISO/IEC Guide 71).
4.6 Продукция с коротким сроком службы
Для продукции, имеющей ограниченный прогнозируемый срок службы, например, по соображениям безопасности, качества или экономической эффективности, должна быть предоставлена информация о годе изготовления, дате истечения срока службы и/или часов работы.
4.7 Рекомендации по построению инструкции по применению
4.7.1 Общие положения
В отношении построения инструкции по применению должно быть принято во внимание следующее:
- стиль письма, например, отказ от использования дискриминационных или оскорбительных выражений;
- правовые требования и стандарты;
- специализированные технологии для подготовки инструкций по эксплуатации;
- соответствующие международные стандарты по удовлетворению потребностей пожилых людей, инвалидов и вопросы доступности. См. ISO/IEC Guide 71.
4.7.2 Расположение
Инструкции по применению должны быть размещены в одном или нескольких из числа следующих мест, если применимо:
- внутри упаковки вместе с продуктом;
- на поверхности или внутри самого продукта;
- на упаковке, но не только на ней;
- на веб-сайтах поставщиков: см. 4.7.5, 5.7 и 6.7, но не только на них.
Однако если перечисленные выше рекомендации по размещению не подходят или не выполнимы для инструкций по применению, то последние должны быть предоставлены в качестве сопроводительной документации.
Если инструкции по применению являются составными, целесообразно, чтобы некоторые важные сообщения были дополнительно приведены или отображается на продукте, например, с помощью коротких ссылок или напоминаний на карточках, наклейках, на иллюстрации или на этикетках.
4.7.3 Средства передачи информации и медиа-средства
Средства передачи информации и медиа-средства должны быть выбраны в зависимости от соответствующей окружающей обстановки и типов целевых групп (включая пользователей детского возраста, пользователей старшего возраста и людей с ограниченными возможностями). Решение о медиа-средствах должны обеспечить, чтобы целевые группы могли иметь постоянный и легкий доступ к информации, необходимой в процессе использования при прогнозируемых обстоятельствах, особенно по вопросам безопасности, применения по назначению, монтажа, действий перед началом работы, пусконаладочных работ, ввода в эксплуатацию, устранения неисправностей, технического обслуживания и утилизации.
В большинстве случаев, например, для потребительских товаров, необходимы печатные версии инструкций по эксплуатации. Поставка инструкций по применению только в электронном формате не допускается во многих случаях, например, для соблюдения требований законодательства.
Ниже приведены примеры возможных средств связи и средств массовой информации:
а) Средства передачи информации:
1) графические символы;
2) текст, видео- (в том числе вспомогательные средства, такие как аудио- и субтитры, когда это уместно), речь;
3) шрифт Брайля, крупный текст, тактильные цифры, знаки или другие видимые жесты;
4) дополнительная документация (например, проспекты, руководства или информация в представлении по Брайлю) или документации на электронных носителях (например, встроенное руководство, информация на носителях или в веб-сайты).
b) Носители информации
1) веб-сайты;
2) соответствующие инструменты с использованием, например, радиочастотной идентификации;
3) проспекты с текстом и иллюстрациями;
4) руководства для пользователей и обслуживающего персонала;
5) графический пользовательский интерфейс.
4.7.4 Долговечность
Инструкции по применению, приложенные к продукту, должны сохранять разборчивость на протяжение всего ожидаемого срока службы продукта.
Инструкции по применению, приводимые на упаковке или в материалах, сопровождающих продукт (например, проспекты, руководства, данные на носителях и т.д.) должны быть выполнены с запасом прочности. Они должны быть спроектированы и изготовлены таким образом, чтобы выдерживать частое использование в течение ожидаемого срока службы продукта в условиях воздействия окружающей среды, в которой продукт предназначен для использования. Например, брошюру, изготовленную из тонкой бумаги, нельзя считать достаточно прочной, если требуются частые обращения к ней.
4.7.5 Доступность
Инструкции по применению должны быть помечены надписью ХРАНИТЬ ДЛЯ СПРАВОК или другим эквивалентным образом, если существует вероятность, что они могут потребоваться в течение срока службы продукта. Поставщик продукта должен хранить копии всех инструкций по применению в течение предполагаемого срока службы продукта. Для каждого потребительского продукта инструкции по применению должны быть, кроме того доступными и легко находимыми на веб-сайтах (см. 5.7 и 6.7).
Так как упаковка обычно недолговечна и разрушается в процессе распаковки, инструкции по применению, которые должны быть сохранены для использования в будущем, не должны быть размещены только на упаковке. Там, где этого невозможно избежать (например, по практическим соображениям), должна быть четко указана рекомендация о необходимости сохранить их для дальнейшего использования. Если инструкции по применению размещены только на части упаковки, то эта часть должны быть легко отделимой от остальной упаковки и иметь соответствующую форму и размеры для удобного хранения.
4.7.6 Электронные путеводители
Когда предоставляется электронный путеводитель, то он должен обеспечить пользователям удобное перемещение внутри информационной структуры, так чтобы пользователи в любое время знали, в каком месте структуры они находятся. Пользователи должны в любое время иметь возможность просматривать на экране информационную структуру вместе с ее узловыми точками и связанной с ними информацией. Пользователь должен иметь возможность сворачивать или расширять структуру системы по мере необходимости.
Предупреждающие сообщения для прогнозируемых исключительных ситуаций, должны быть отнесены только к тем узлам в структуре, которых они касаются.
4.7.7 Обучение пользователей
Если обучение пользователя не требуется, то это должно быть указано в инструкции по применению и, при необходимости, также в договоре на поставку. Тем не менее, курсы обучения пользователей не могут служить заменой инструкций по применению, а являются только дополнением к ним. Курсы обучения пользователей должны быть организованы в тех случаях, когда инструкции по применению сами по себе не могут обеспечить выполнение общих требований, приведенных в 4.1.1, из-за сложности продукта или необходимости предоставления более полной информации пользователю, либо когда не ожидается достаточных знаний со стороны пользователя.
4.8 Разработка инструкций по применению
4.8.1 Соответствие продукту
4.8.1.1 Взаимосвязь между инструкциями по применению и продуктом
Инструкции по применению должны однозначно соотноситься с поставляемым продуктом, следовательно, они должны содержать информацию по идентификации нанесенной на продукт маркировки. Они, как минимум, должны содержать наименование и адрес поставщика, обозначение серии или типа, название продукта, вид документа и, если применимо, серийный номер и рисунок продукта.
Если на продукт распространяется действующий стандарт, это должно быть четко указано. Для требований по идентификации см. IEC 62507-1. См. также 5.3.
Все инструкции по применению, которые поставляются медиа-средствами, а не с самим продуктом, должны содержать дату издания и должны быть идентифицируемыми визуально или по номеру версии.
4.8.1.2 Модели продукта
Если комплект инструкций по применению адресован более чем одной модели продукта, идентификатор конкретной модели должен быть четко узнаваемым в инструкциях по применению и на самом продукте, чтобы обеспечить однозначную идентификацию. Взаимосвязь между содержанием инструкции и эксплуатационными особенностями различных моделей продукта должна быть однозначной.
В случае, когда один документ охватывает несколько моделей одного продукта, используют различные способы организации информации, например:
a) Для каждой модели продукта имеются свои собственные разделы. Общие части повторяются в каждом разделе модели продукта. При таком решении количество страниц возрастает, но с точки зрения пользователя чтение документа облегчается (все содержимое раздела относится к конкретной модели продукта) и риск неправильного толкования снижается. Обозначение рассматриваемой модели продукта выносят, например, в верхний или нижний колонтитул на каждой странице (см. 5.3).
b) Для всех моделей продукта имеется один общий раздел. Конкретную информация о моделях продукта выделяют с использованием, например, подзаголовков разных цветов. Такое решение будет компактнее, но особое внимание должно быть обращено на реализацию и проверку инструкции по применению.
При использовании варианта b) результат должен быть проверен с применением экспертной оценки, так как присутствует повышенный риск неправильного толкования.
4.8.1.3 Информация по установке и техническому обслуживанию
Части инструкции по применению, относящиеся к установке и обслуживанию, должны включать, как минимум, адреса поставщика и уполномоченных сервисных центров для данного продукта. Следующая информация должна быть включена, если это применимо: технические данные, гарантийные обязательства, поиск и устранение неисправностей, список расходных материалов и указания по утилизации.
4.8.1.4 Единицы измерения
Обычно величины должны быть выражены в единицах СИ (Международная система единиц измерения) или в производных единицах от единиц СИ (ISO/IEC 80000). Тем не менее, величины в инструкции по применению должны соответствовать единицам измерения, используемым в продукте. Там, где единицы измерения СИ не используются, должны быть приведены их эквиваленты.
4.8.1.5 Дополнительные модули и дополнительное оборудование
Инструкции по применению дополнительных модулей или дополнительного оборудования должны быть четко отделены от общих инструкций по применению и от инструкций по применению для других модулей или дополнительного оборудования (например, путем создания отдельных разделов, заголовков и т.д.), чтобы пользователи не отвлекались неактуальной информацией.
Если продукт допускает, например, возможность установки в батарейный отсек как аккумуляторов, так и неперезаряжаемых батарей, инструкции по эксплуатации должны включать отдельные пункты для вариантов:
a) использования аккумуляторов;
b) использования неперезаряжаемых батарей.
4.8.1.6 Специальные инструменты, оборудование, материалы
Инструкции по применению должны содержать информацию для подсоединяемых аксессуаров и другого оборудования, включая указания по выбору аксессуаров, съемных частей и любых специальных материалов, насколько это применимо. Инструкции по применению должны также содержать наименование и адреса поставщиков специальных инструментов, материалов и т.п., а также информацию о том, где можно получить техническую поддержку.
При необходимости должна быть предусмотрена информация о переупаковке, замене, ремонте, доработке, заправке и т.д.
4.8.2 Рассмотрение потребностей целевых групп
4.8.2.1 Анализ целевых групп
Рассмотрение потребностей целевых групп должно основываться на анализе, изложенном в 4.4. Для потребительской продукции рекомендуется пользоваться эмпирическими оценками. См. также приложение Е.
4.8.2.2 Целевые группы с особыми потребностями
Если продукция предназначена для использования целевыми группами с особыми потребностями, инструкции по применению должны принять это во внимание. Целевые группы с особыми потребностями включают, например, пожилых людей, детей или других лиц, не способных без присмотра пользоваться продуктом безопасно, инвалидов, наблюдающих за детьми взрослых и малограмотных людей.
4.8.2.3 Приемлемая терминология
Инструкции по применению должны быть понятными широкой публике, если только продукт не предназначен для использования конкретной целевой группой со специальными знаниями. Если использование технических терминов и выражений избежать невозможно, их значения должны быть разъяснены.
4.8.2.4 Значения сигналов
Значения сигналов, таких как мигание индикаторов, изменение цвета или звуковые сигналы, должны быть пояснены таким образом, чтобы они были легко узнаваемы и понятны целевой группе.
Примечание - Примеры сигнальных знаков приведены в IEC 60073, ISO 7731, ISO 11429, ISO 15006 и ISO/TR 16352.
4.8.2.5 Дополнительная информация
Если приводится дополнительная информация для конкретных целевых групп или с определенной целью, то об этом должно быть четко указано на первой странице инструкции по применению.
Если дополнительную информацию можно получить через другие медиа-средства, это также должно быть указано (см. 4.7.3).
4.8.3 Языки
4.8.3.1 Общие положения
Инструкции по применению должны быть представлены на официальном языке (языках) страны продажи в соответствии с местными или региональными правовыми требованиями.
При выборе дополнительного языка (языков) для инструкций по применению следует принимать во внимание следующее:
a) туристы, этнические меньшинства и трансграничные покупатели через Интернет, вероятно, будут представлять значительную (и все возрастающую) долю среди покупателей многих продуктов на рынках многих стран;
b) значительное число целевых групп (например, мигранты и беженцы) не являются носителями государственного языка(ов) страны, в которой они проживают. Поэтому они будут вынуждены пользоваться продукцией, не имея инструкций по применению, написанных на языке, который они понимают в достаточной мере.
Если инструкции по применению приведены на нескольких языках, они должны быть выделены соответствующим обозначением, например, кодом для обозначения названий языков в соответствии с ISO 639-2. Для того чтобы упростить пользование, инструкции по применению на разных языках должны быть представлены раздельно.
Одна иллюстрация может обслуживать более одного языка при условии, что иллюстрация приводится вместе с текстом на каждом языке и она не содержит специфических элементов языка.
Кроме того, ответственные действия и меры безопасности могут быть переданы независимыми от языка средствами, такими как графические символы, включая знаки безопасности, и не требующие пояснений иллюстрации.
4.8.3.2 Графические символы, в том числе знаки безопасности и этикетки безопасности продукта
Графические символы, в том числе знаки безопасности и этикетки безопасности продукта, должны быть легко узнаваемыми и понятными для целевой группой. Графические символы, включая знаки безопасности, используемые на продукте или в инструкциях по применению и не являющиеся доступными для понимания, или однозначными, должны быть разъяснены.
Из-за ограниченного доступного пространства размещение инструкций по применению на продукте может натолкнуться на проблемы, связанные с использованием языков, особенно в стране, где инструкции по применению будут предоставляться более чем на одном официальном языке. Эти проблемы могут быть решены путем использования:
- графических символов, включая знаки безопасности и этикетки безопасности на продукте (см. 6.4), смысл которых очевиден;
- буквенно-цифровых кодов с объяснением смысла;
- определенных слов или сокращений (например, STOP, MAX/MIN), получивших международное признание.
Примечание 1 - В стандартах ISO 7010, IEC 60417 и ISO 7000 приведены знаки безопасности и графические символы, стандартизованные на международном уровне.
Примечание 2 - Серия стандартов ISO 9186 устанавливает процедуры для проверки сложности понимания графических символов, включая знаки безопасности.
4.8.3.3 Качество переводов
Когда инструкции по применению переводят с языка оригинала на другие языки, эксперты-переводчики или специалисты должны нести ответственность за перевод, включая проверку и корректуру, а также:
- быть компетентными в средствах коммуникаций, особенно телекоммуникаций;
- быть знакомыми с предметной областью;
- свободно говорить на языке оригинала и языке перевода, желательно, чтобы язык перевода был родным для них.
Разговорных выражений и нетипичных региональных вариаций наименований продукта и его характеристик следует избегать.
Переведенные инструкции по применению должны быть отредактированы квалифицированными специалистами, специализирующимися на написании и переводе текстов для целевых групп.
5 Содержание инструкций по применению
5.1 Общие положения
В инструкции по применению должна быть описана функциональность продукции и должны содержаться соответствующие варианты ответов на такие ожидаемые вопросы пользователей, как ГДЕ? КТО? ЧТО? КОГДА? КАК? ПОЧЕМУ?
Приводимая информация будет зависеть от целевой группы (групп) и задач, для которых она предназначена или которые позволено выполнять на протяжении всего срока службы продукта.
Если продукт будет поставляться на рынки, где национальное законодательство запрещает его установку и обслуживание неквалифицированными лицами, это должно быть ясно указано на всех языковых версиях инструкций по применению, которые имеют отношение к этим рынкам.
5.2 Идентификация инструкций по применению
Инструкции по применению должны иметь уникальное идентификационное обозначение, включающее:
a) идентификационный номер;
b) дату выпуска;
c) указатель пересмотра и дату пересмотра, если применимо;
d) наименование издателей инструкций с адресами, если последние отличаются от адреса поставщика.
5.3 Идентификация продукта
Спецификация или описание продукта должны позволить пользователю идентифицировать продукт при помощи:
- идентификационного номера продукта, серийного номера, модели и/или типа, см. IEC 62507-1;
- наименования или идентификационной информации поставщика в совокупности с контактными данными поставщика, такими как доступные телефонные номера, номера факсов и любые другие возможные средства связи;
- наименования, адреса, номеров телефонов, факсов, адреса электронной почты и веб-адреса поставщиков специального инструмента, материалов и т.д. и служб технической поддержки.
Кроме того, спецификация или описание продукта должны давать общее представление о требованиях, производительности и функциональных возможностях, а также предоставлять следующую информацию, насколько это применимо:
- основные параметры, например, масса, объем и производительность;
- данные о потребляемой энергии и входном напряжении, категории изоляции (в случае изоляции класса II маркировка графическим символом по IEC 60417-5172 (2003-02), в случае изоляции класса III маркировка графическим символом по IEC 60417-5180 (2003-02)) и IP-коде в соответствии с IEC 60529;
- класс энергоэффективности;
- требования по газоснабжению (например, тип, давление), водоснабжению и другая соответствующая информация по таким вопросам, как моющие средства, смазочные материалы, плавкие предохранители (например, тип, номинальное значение и характеристики);
- уровень шума, скорость сброса сточных вод и т.д. при заданных условиях;
- электромагнитная совместимость;
- описание характера предполагаемого пользователя (и, особенно, в случае продукции широкого применения, четкое изложение любых специальных мер предосторожности, которые должны соблюдаться пользователями (см. ISO/IEC Guide 71));
- стандарты и правовые требования, которым продукт должен соответствовать;
- записи по назначению и обоснованно предсказуемому неправильному использованию.
Принципы и методы детальной спецификации продукции приведены в IEC/PAS 62569-1.
Некоторые стандарты на продукцию могут потребовать нанесения конкретной маркировки или этикетки на продукт и/или на относящиеся к нему инструкции по применению, чтобы подтвердить соответствие продукта конкретным требованиям этих стандартов.
5.4 Модификация продукции
Если поставщик не разрешает модифицировать продукт, это должно быть четко указано в инструкциях по применению, в том числе приведена информация о возможных последствиях в результате модификации.
При необходимости должно быть четко указано, что любая модификация продукта пользователем не рекомендуется и любые последствия не будут компенсированы сервисной службой или гарантией на продукт.
Если поставщик позволяет пользователю модифицировать продукт, инструкции по применению должны указывать на допустимость (или недопустимость) модификаций. Инструкции по применению должны подробно пояснять и иллюстрировать, как осуществлять допустимые модификации (или отсылать пользователя к источнику соответствующей информации), чтобы позволить пользователю правильно модифицировать продукт и при этом обеспечить стабильное безопасное и эффективное использование.
5.5 Информация о системе безопасности
5.5.1 Общие положения
Существуют три вида информация о системе безопасности, которые следует рассмотреть отдельно:
- указания по технике безопасности;
- предупреждающие сообщения;
- этикетки безопасности или знаки безопасности продукта.
Примечание - ISO 3864 определяет ряд знаков безопасности и этикеток безопасности продукции.
Информация о системе безопасности должна относиться к различным этапам срока службы продукта.
Информация о системе безопасности должна включать следующие сведения, если это применимо:
- назначение продукта, основная функция или цель и сфера применения и основные принципы безопасности, которые должны соблюдаться;
- границы применения в отношении, например, места, времени, окружающей среды и типового применения, материалов и добавок, необходимых инструментов, а также климатических условий эксплуатации и хранения, таких как температура и влажность, взрывоопасная среда, работа на открытом воздухе;
- визуальная информация о средствах индивидуальной защиты (например, спецодежда, защитные очки), которые необходимы для безопасного использования продукта;
- защитные меры, которые должны быть установлены или активированы пользователями;
- потенциальные опасности или меры предосторожности для определенных групп лиц, о которых пользователи должны знать и которые не были бы очевидны без специального указания;
- потенциальные последствия для здоровья, которые могут возникнуть в результате несоблюдения защитных мер или пренебрежения опасностью, если риск и тяжесть последствий не являются очевидными;
- описание типа пользователей, например, квалифицированные лица или обычные люди старше 18 лет;
- сведения об ограничениях на персонал, которому разрешается использовать продукт, с указанием любых требуемых специальных навыков;
- конкретные признаки того, что продукция не безопасна в использовании, например, из-за износа, старения или повреждений:
- информация о безопасной утилизации;
- пояснение графических символов, используемых в информации о системе безопасности (см. ISO 7000, ISO 7010, IEC 60417.);
- ограничения и/или рекомендации для безопасного использования, например, использование в сухой среде, или запрет на использование в ванных комнатах или других влажных средах;
- сигнальные слова и/или графические символы, включая знаки безопасности;
- предупреждающие надписи об опасностях;
- предупреждающие надписи о прогнозируемом ненадлежащем использовании;
- предупреждающие надписи об излучении, в том числе о любых скрытых опасностях, например, источниках ионизирующего излучения, лазерном излучении (в соответствии с IEC 60825-1), излучении микроволновой печи, ультрафиолетовом, инфракрасном излучениях и опасном для жизни напряжении;
- необходимость предотвращения доступа детей или контакта с домашними животными, растениями или насекомыми.
Информация об индивидуальных средствах защиты должна быть дополнительно приведена на упаковке и/или на самом изделии.
Ограничения, налагаемые на использование продукта, должны быть ясно указаны в инструкциях по применению, например, в спецификации и в коммерческих буклетах в точке продажи (см. также ISO/IEC Guide 14).
Примечание - Стандарты на продукцию и правовые нормы могут содержать дополнительные требования.
5.5.2 Указания по технике безопасности
Указания по технике безопасности должны быть представлены в виде значимой упорядоченной системы. Они должны быть включены в отдельный пункт или раздел в начале инструкций по применению. Этот пункт или раздел должен быть четко обозначен и должен иметь заголовок, который подчеркивает важность его содержания.
Указания по технике безопасности должны, как минимум, гарантировать способы безопасного использования продукции, обращать внимание на потенциальную опасность и на методы по устранению такой опасности, а также сообщать о тяжести возможных последствий при невыполнении их.
5.5.3 Предупреждающие сообщения
Предупреждающие сообщения должны быть приведены в контексте с ситуацией, в которой опасность может возникнуть. Они указывают на потенциальные опасности и возможные последствия, если их игнорировать.
Предупреждающие сообщения должны быть лаконичными. Они не должны содержать полного описания процедур, а лишь дополнять процедуры, описанные в другом месте в инструкциях по применению. Должна быть включена информация о предотвращении опасности. Однако, если информация о предотвращении опасности очевидна для целевых групп, то предупреждающее сообщение может быть опущено.
5.5.4 Информация о системе безопасности для промышленных предприятий
Информацией о системе безопасности должен быть снабжен каждый компонент. Если при сборке компонентов могут возникнуть дополнительные потенциальные опасности, то соответствующая информация о системе безопасности должна быть обеспечена только на соответствующем уровне сборки. При интеграции компонентов на более высоких уровнях сборки, связанная с безопасностью информация должна предоставляться только на том уровне сборки, которого она касается.
5.5.5 Связанная с безопасностью информация в кратком руководстве пользователя
Краткие руководства пользователя должны содержать всю критически важную для безопасности информацию, относящуюся к описываемым действиям. Они должны также предоставлять пользователям рекомендации о том, почему и когда они должны прочесть дополнительную информацию по безопасности в инструкциях по применению.
5.6 Соответствие продукта нормам и стандартам
В инструкциях по применению, при необходимости, должна быть помещена информацию о правовых и других требованиях, предъявляемых к продукту.
5.7 Важность сохранения инструкций по применению
Внимание пользователя должно быть обращено на важность сохранения инструкций по применению в течение срока службы продукта посредством заявления типа:
ВАЖНО - ВНИМАТЕЛЬНО ПРОЧИТАТЬ ПЕРЕД ПРИМЕНЕНИЕМ. ХРАНИТЬ ДЛЯ БУДУЩЕГО ИСПОЛЬЗОВАНИЯ.
Должна быть обеспечена возможность замены копий всех таких инструкций по применению у поставщика по требованию (например, с веб-сайта) на протяжении всего ожидаемого срока службы продукта.
5.8 Подготовка продукции к эксплуатации
5.8.1 Транспортирование и хранение
При необходимости, инструкции по применению должны содержать информацию по защите продукта и обеспечению безопасности людей во время транспортирования и хранения, например:
- размеры, масса и центр тяжести;
- методы подъема, перемещения и транспортировки, которые являются экономически эффективными и позволяют предотвратить вредные последствия (например, путем указания точки захвата и ограничения доступа к винтовым соединениям);
- требования к хранению при соответствующих условиях окружающей среды (например, влажность, горизонтальное положение, избегать прямых солнечных лучей);
- хранение продукта после использования, а также
- методы защиты продукта от неожиданных ударов.
5.8.2 Установка
Для продукции, требующей установки, инструкции по применению должны при необходимости включать в себя:
- методы удаления транспортировочных и упаковочных ограничителей движения, а также оборудования транзитных зажимов;
- процедуры распаковки (обеспечиваемые снаружи упаковки), а также удаления и безопасного обращения с любой защитной упаковкой;
- контрольный список вложений в упаковку;
- минимальное пространство, необходимое для использования, обслуживания и ремонта;
- планировка;
- схема соединений и/или таблица;
- условия для сборки и монтажа;
- методы, меры предосторожности и правовые требования для подключения продукта к системам энерго- и водоснабжения, канализации и другим вспомогательным источникам ресурсов.
5.8.3 Ввод в эксплуатацию
Инструкции по применению должны содержать всю информацию, необходимую для ввода в эксплуатацию продукта перед его передачей в рабочем состоянии пользователю.
5.9 Функционирование продукции
5.9.1 Общие положения
Пользователь должен быть снабжен информацией о нормальном и безопасном функционировании, а также о возможных нарушениях в функционировании продукта.
5.9.2 Нормальный режим работы
Инструкции по применению, при необходимости, должны содержать следующие сведения:
- информацию, относящуюся к условиям окружающей среды;
- информацию о любых методах работы в ручном режиме;
- информацию о местном/дистанционном управлении и о способе переключения между ними;
- информацию о ручном режиме и автоматическом режиме и о способе переключения между этими двумя режимами работы;
- информацию о вибрации для портативных ручных машин и машин и оборудования с ручным управлением;
- о средствах запуска/остановки функционирования продукта;
- о любом запуске функционирования, проверках, настройках или требованиях к заправке перед каждым случаем нормального использования;
- иллюстрации, которые разъясняют или облегчают понимание основных функций и мер предосторожности;
- рекомендации по удалению отходов;
- выявление и устранение неисправностей.
5.9.3 Дополнительная информация для автоматической и дистанционно управляемой продукции
Система руководств пользователя должна предоставлять пользователю в режиме онлайн дополнительную информацию о рабочем состоянии продукции. Например:
- полную информацию о нормальной работе;
- признак того, что система автоматически переключается в безопасный режим работы до возникновения опасной ситуации;
- текущее состояние работы, чтобы пользователь имел представление об автоматически управляемых функциях;
- что делать в случае сбоя самой системы управления;
- инструкция о том, как управлять продуктом в аварийной ситуации;
- информацию о том, находится ли система в ручном, местном или автоматическом режиме.
Примечание - О документации по программному обеспечению систем руководства пользователя см. IEC 61506.
5.9.4 Индикация неисправностей и предупредительные сигнальные устройства
Распознавание и индикация нормального и ненормального функционирования и распознавание сигналов от любого предупредительного устройства должны быть пояснены в инструкции на носителе информации, которая может быть вызвана без функционирования самого продукта.
Любые сигналы или дисплеи, предназначенные для индикации прогнозируемого риска повреждения или неминуемой опасности, должны быть легко понятными и однозначными.
Соответствующие предупреждения должны быть предусмотрены там, где использование данного продукта может повлиять на электрические управляющие медицинские устройства, такие как кардиостимуляторы.
Должны быть предоставлены рекомендации, позволяющие пользователям диагностировать любые медицинские симптомы или неблагоприятные медицинские реакции, которые могут возникнуть в результате использования продукта, и предпринять корректирующие действия или лечение.
5.9.5 Чрезвычайные или аварийные ситуации
При необходимости должна быть предусмотрена информация по следующим ситуациям:
- последовательность действий, которые необходимо предпринять в случае неожиданного отключения электропитания, охлаждения и т.д.;
- индикация неисправности и ее локализация;
- перезапуск после вмешательства в функционирование;
- какой тип противопожарного оборудования использовать в случае возможного пожара;
- сведения о предполагаемых выбросах или утечки веществ с соответствующими предупреждениями о характере любых опасностей, включая меры предосторожности, чтобы избежать ущерба и, если это возможно, контрмеры для восстановления нормального рабочего состояния;
- рекомендации по оказанию первой медицинской помощи для любого прогнозируемого острого заболевания, которое может возникнуть в результате использования продукта, например, инфекционно-токсический шок, приступ эпилепсии или ожоги, и рекомендации по организации последующей профессиональной медицинской помощи.
5.9.6 Устранение неполадок и ремонт неквалифицированными лицам
Если пользователю продукта позволено осуществлять поиск и устранение неисправностей без риска причинения вреда самому себе, другим людям или нарушения безопасности продукта, то инструкции по применению должны содержать перечень возможных неисправностей (или "часто задаваемых вопросов-ответов"). Перечень часто задаваемых вопросов-ответов, включая соответствующие иллюстрации, должен дать четкое указание тех неисправностей, которые пользователь может попытаться устранить. Указания по ремонту неисправностей должны быть ограничены теми задачами, решение которых по силам пользователю без технического образования.
В инструкции на носителе информации, которой можно воспользоваться без функционирования самого продукта, должны быть представлены сведения о телефоне, электронной почте и веб-контакте для передачи жалобы или запроса в сервисную службу. Список мест размещения и контактные данные поставщика в стране или странах, в которые поставляется продукция, должен прилагаться к продукту или быть доступным на веб-сайте поставщика.
5.9.7 Поиск неисправностей и ремонт квалифицированным персоналом
Следующая информация должна быть, при необходимости, предоставлена:
- перечень признаков для идентификации неисправности и места ее нахождения;
- перечень признаков нормального функционирования;
- описания встроенных диагностических систем для обнаружения неисправности;
- чертежи и схемы, позволяющие эффективно решать задачи по поиску и устранению неисправностей;
- указания по записи о неисправности оборудования, записи симптомов и признаков ненормальной работы, и записи тревожных вызовов и поездок;
- указания для стартовых резервных или альтернативных систем, а также по снятию с эксплуатации и изолированию неисправных единиц;
- о ремонте и регулировках;
- о средствах для поиска неисправностей, таких как функционально идентифицированная система технического обслуживания, пошаговая диагностика неисправностей, алгоритмы обнаружения неисправностей или, в случае сложных систем, дерево отказов и компьютерная диагностика неисправностей;
- четкое определение задач по поиску неисправностей и ремонту, которые не должны быть предприняты пользователем, вместе с инструкциями о том, как связаться с поставщиком или другими лицами, у которых может быть получена техническая помощь;
- имя, адреса, доступные телефонные номера, номера факсов и любые другие средства для связи с поставщиком или другими лицами, у которых может быть получена техническая помощь.
5.10 Техническое обслуживание продукта
5.10.1 Общие положения
Должна быть предоставлена информация по техническому обслуживанию, которое может быть выполнено квалифицированными и неквалифицированными лицами - предпочтительно в виде отдельных документов или по крайней мере в виде отдельных пунктов.
5.10.2 Техническое обслуживание продукта неквалифицированными лицами
Если пользователю продукта позволено выполнять задачи по техническому обслуживанию без вреда для себя, других людей, или продукта, то инструкции по применению должны содержать конкретные описания этих задач, их характер и частоту.
Инструкции по применению должны содержать перечень возможных задач по техническому обслуживанию с соответствующими иллюстрациями по мере необходимости, чтобы пользователи могли выполнять эти задачи эффективно и без труда.
Если определенные задачи по техническому обслуживанию необходимо проводить чаще, чем другие, то ежедневные задачи по техническому обслуживанию должны быть отделены от периодического (краткосрочного и долгосрочного) технического обслуживания и инспектирования.
Также должны быть указаны материалы и инструменты, используемые для очистки, например, соответствующие химические вещества, салфетки для уборки и щетки. Риски, связанные с использованием ненадлежащих материалов и инструмента, должны быть четко определены.
При наличии задач по техническому обслуживания, которые не позволено выполнять пользователю, эти задачи должны быть четко определены и пользователь должен быть проинструктирован, каким образом можно связаться с поставщиком или другими лицами, у которых может быть получена техническая помощь.
5.10.3 Обслуживание продукта квалифицированным персоналом
Информация по обслуживанию квалифицированным персоналом должна включать:
- характер и частоту проверок;
- меры безопасности и предупреждения при проведении обслуживания на работающем оборудовании;
- чертежи и схемы, позволяющие эффективно решать задачи по обслуживанию;
- регулярные проверки предупреждающих устройств;
- сведения о методах чистки. Там, где существует возможность неправильной очистки или дезактивации или использование неправильных чистящих средств, создающих угрозу безопасности или проблемы, связанные с коррозией или ослаблением структурных частей продукта, это должно быть конкретно указано;
- планы технического обслуживания и, при необходимости, генеральные планы, которые включают подробную информацию о всех задачах, проводимых на регулярной основе;
- имя, адреса, доступные телефонные номера, номера факсов и любые другие средства связи с поставщиком или другими лицами, у которых может быть получена техническая поддержка.
5.10.4 Выполнение плановых работ по техническому обслуживанию на промышленных предприятиях
Общее техническое обслуживание и сервисный план для промышленного предприятия составляют путем объединения процедур по техническому обслуживанию и сервисных планов для всех ключевых компонентов.
5.11 Поставка аксессуаров, расходных материалов и запасных частей
5.11.1 Аксессуары
Следующая информация, с учетом ее необходимости для каждого вспомогательного устройства, должна быть приведена в инструкциях по применению:
- название, номер части и основное или дополнительное устройство;
- иллюстрации, позволяющие пользователю идентифицировать аксессуар и место его установки;
- описание функции и цели аксессуара.
5.11.2 Расходные материалы
Если требуются расходные материалы, то в инструкциях по применению должна быть приведена следующая информация:
- описание и рекомендуемое количество расходных материалов, наименование модели поставщика или номер части, любые общие коммерческие названия (и, на материалы, родовое название);
- типовая частота замены (по времени или по объему потребления);
- иллюстрация, позволяющая пользователю идентифицировать расходные материалы;
- иллюстрация, показывающая позицию или доступ к расходным материалам (в разобранном виде, если это будет более ясно);
- информация по удалению и замене или заправке;
- информация по утилизации удаленных расходных материалов.
5.11.3 Запасные/сменные части
Должен быть предусмотрен перечень запасных частей, которые необходимо приобрести. Следующая информация должна быть приведена, при необходимости, для каждой части вместе с указанием требуемой квалификации для замены этой части, чтобы избежать потенциальной опасности:
- ее наименование, идентификационный и серийный номер в форме, используемой на самом изделии и в коммерческих операциях;
- поставщики часть/типа и номер версии, а также название, справочный номер и номер версии для фирменных частей, если отличаются от указанных выше;
- рисунок части и ее расположения, предпочтительно в разобранном виде;
- источники поставки, а также альтернативные источники поставок запасных частей;
- части, для которых поставщиком или сервисной службой предоставляются реставрационные услуги;
- идентификация в соответствии с IEC 81346 компонентов сложной продукции;
- идентификация в соответствии с IEC 81346 мест, где конкретная запасная часть может быть использована в качестве замены;
- год изготовления или год истечения срока годности для запасных/сменных частей, наличие, если они не приведены в отдельном документе;
- сведения по утилизации удаленных запасных/сменных частей.
5.12 Информация о специальных инструментах, оборудовании и материалах
Информация о любых специальных инструментах, предметах, или оборудовании, необходимых для использования в особых условиях, но не используемых в нормальном режиме, как правило, эта информация не должна предоставляться неквалифицированным лицам. Подобная информация должна предоставляться только квалифицированным специалистам.
Информация должна включать описание взаимосвязей продукта с принадлежностями и другим оборудованием, включая указание на подходящие аксессуары, съемные части, и любые специальные материалы, которые могут быть использованы.
При необходимости должны быть предусмотрены методы повторной упаковки для замены, ремонта, переделки и заправки продукта.
Расходные, чистящие материалы, смазочные материалы и ремонтные комплекты должны быть по возможности идентифицированы.
5.13 Информация по ремонту продукции и замене деталей
5.13.1 Информация по ремонту продукции и замене деталей неквалифицированными лицами
Информацию для потребителей по ремонту и замене деталей приводят, если эти работы могут быть выполнены ими без риска причинения вреда самим потребителям, другим людям или снижения безопасности при использовании продукта.
Если поставщик и региональные законы разрешают потребителям самим заменять некоторые детали, то потребителям должна быть предоставлена следующая информация:
- источник приобретения запасных частей;
- метод ремонта или замены;
- метод проверки после ремонта или замены, если такие проверки требуются.
Когда поставщик не допускает замену деталей потребителями, должна быть приведена информация для связи с сервисной службой (службами).
5.13.2 Информация по ремонту продукции и замене деталей квалифицированным персоналом
Должна быть предусмотрена следующая информация о ремонте и замене деталей квалифицированными специалистами:
- по ремонту оборудования и/или замене его частей;
- по проведению проверок, которые должны быть выполнены после замены части.
5.14 Информация, необходимая, когда продукт больше не будет использоваться
5.14.1 Общие положения
Инструкции по использованию должны содержать информацию, относящуюся к обработке, переработке или утилизации продукта после прекращения его эксплуатации.
5.14.2 Разборка
Разборка потребителем допускается только в тех случаях, когда это не создает опасности.
При необходимости, инструкции по применению должны содержать информацию, в виде отдельного документа или в общем сборнике, по разборке продукта и/или обращению с любыми отходами с учетом требований безопасности и охраны окружающей среды.
5.14.3 Переработка
Если для утилизации продукта или его элементов необходимы конкретные процедуры, они должны быть указаны в соответствии с относящимися к ним соответствующими правовыми нормами и/или стандартами.
5.14.4 Утилизация
Инструкции по применению должны включать важную информацию для пользователей об утилизации отходов и охране окружающей среды.
Если продукт содержит опасные вещества, или если опасные вещества поставляются вместе с продуктом, то должна быть предоставлена необходимая информация о таких составляющих и о правильной процедуре обращения с продуктом с учетом требований безопасности и правовых норм.
5.15 Структура инструкций по применению
5.15.1 Общие положения
Инструкции по применению большого объема или комплексные должны быть четко разделены на удобные разделы и иметь единый формат. Требования к конкретным разделам должны быть установлены в соответствующих стандартах на продукт или в отраслевой технической документации с учетом положений настоящего стандарта.
В инструкциях по применению, содержащих набор руководств, информация на обложках и/или на корешке переплета должна позволять легко отличить одно руководство от другого.
5.15.2 Нумерация страниц
Если инструкции по применению содержат более двух (печатных) страниц, то страницы должны быть пронумерованы. Рекомендуется, чтобы они были пронумерованы, как "n из m", где n - фактический номер страницы, а и m - общее количество страниц.
5.15.3 Оглавление
Инструкции по применению, объем которых превышает четыре страницы, должны иметь оглавление, если только не очевидно, что в нем нет необходимости.
Колонтитулы и номера страниц, представленные в оглавлении, должны иметь тот же формат, как и в тексте.
5.15.4 Индексация
Если инструкции по применению объемные и комплексные, то в оглавление должен быть включен список индексных ключевых слов, представленных в алфавитном порядке.
5.15.5 Технические термины, аббревиатуры и сокращения
Неизбежные технические термины, аббревиатуры и сокращения, не всегда понятные предполагаемой целевой группе, должны быть сведены в список и объяснены.
Для потребительской продукции целесообразно провести эмпирическую проверку, если имеются сомнения относительно понимания технических терминов целевой группой. Когда технические термины часто используются в инструкциях по применению, рекомендуется включать глоссарий.
Единая терминология должна быть использована в инструкциях по применению, на изделии, на упаковке и, в соответствующих случаях, в сопроводительных документах, таких как руководства по эксплуатации.
5.15.6 Графические и тактильные символы и тактильные точки
Графические и тактильные символы и тактильные точки должны быть перечислены и объяснены.
5.15.7 Соглашения по представлению
Соглашения по представлению материала, используемые в инструкциях по применению, должны быть перечислены и объяснены, например использование конкретного шрифта для описания действий, которые будут осуществляться пользователем.
5.15.8 Пользовательское управление и индикаторы
При возможности инструкции по эксплуатации должны содержать описание пользовательских элементов управления и индикаторов, применительно к соответствующим компонентам.
6 Представление инструкций по применению
6.1 Простота понимания
6.1.1 Признанные коммуникационные принципы
Внутри каждого раздела инструкций по применению процесс обучения пользователя должен быть, насколько это возможно, разбит на последовательность небольших шагов. Степень понимания их непрерывной последовательности может быть усилена путем нумерации операционных этапов и/или путем отсылки пользователя (на каждом шаге) к рисунку, наглядно или схематически иллюстрирующему каждое действие. Каждый шаг должен относиться к отдельной операции.
Функции информационных разделов (например, описание продукта или информация об утилизации), должны быть легко идентифицируемыми и различные виды информации должны быть четко определены.
В инструкциях по процедурам объяснение последовательности необходимых шагов должно быть приведено до описания последовательности выполняемых действий.
Там, где это возможно (в частности, при описании сборки) пользователь должен прочесть содержимое одного учебного шага, затем выполнить предписанное действие, оценить эффект, и потом читать текст следующего шага.
Должны быть использованы методы структурирования инструкций по применению, ориентированные на правильное использование продукта ("что" должно быть сделано с продуктом и "как", в правильном порядке). Общие аспекты должны быть описаны в обзорной главе, конкретные аспекты - в соответствующем контексте.
Использование иллюстраций увеличивает усвояемость инструкций по применению. Рекомендуется добиваться эффективного баланса текста и иллюстраций. Иллюстрации должны быть снабжены уникальными номерами, на которые можно ссылаться в тексте.
6.1.2 Руководство по стилю
Руководство по стилю должно быть утверждено и должно соблюдаться во всех инструкциях по применению, например:
- стиль письма (см. таблицу 1);
- формулировки;
- постоянно используемые термины;
- манера обращения к читателям;
- оформление текста и макет страницы, включая выбор типа и размера шрифта (см. таблицу 2).
6.1.3 Структура
Формулировка должна соответствовать структуре, которая поддерживает различные функции текста. К таким функциям текста, например, относятся:
- тема (заголовок);
- описание;
- цель:
- предпосылка,
- состояние;
- действия;
- результат;
- предупреждение;
- подсказка и напоминание;
- пример;
- подпись (к рисунку или таблице).
Рекомендуется использование метода последовательного структурирования.
Инструкции по применению должны, в первую очередь, охватывать основные или нормальные функции, а затем уже и другие функции.
Заголовки должны быть простыми для понимания и предпочтительно должны быть краткими и пронумерованными. В качестве структурных элементов они должны служить руководством пользователю для чтения инструкций по применению, и должны помогать пользователю в поиске необходимой информации.
6.1.4 Непротиворечивость терминологии
Терминология должна использоваться логично в соответствии с требованием к редакционному стилю, способствуя таким образом повышению усвояемости.
Непротиворечивая терминология должна использоваться собственно в инструкциях по применению, на упаковке, в других сопроводительных документах, и на самом продукте.
6.1.5 Простота и краткость
Информация должна быть максимально простой и по возможности краткой, и должна быть представлена в непротиворечивых терминах и выражениях. Структура предложения должна быть простой. Предложения должны быть короткими и должны быть грамматически правильными.
Перекрестные ссылки должны быть сведены к минимуму.
6.1.6 Одно предложение - одно указание
Одно предложение должно содержать только одно указание, или в крайнем случае небольшое числа тесно связанных указаний.
6.1.7 Правило простых формулировок
Текст инструкций по применению должен быть изложен простыми, ясными, прямыми фразами в виде коротких предложений, следуя принципу "Одна фраза - одна простая мысль". Логическая структура текста должна быть понятной.
Аббревиатур и сокращений следует избегать, за исключением случаев, когда они знакомы предполагаемым пользователям или при условии их пояснения при первом упоминании в инструкции по применению и/или в глоссарии.
Примеры, приведенные в таблице 1, должны соблюдаться независимо от используемого языка.
Примечание - Переводчики настоящего стандарта могут заменить примеры в таблице 1 выражениями на языке, на котором выполняется перевод.
Таблица 1 - Примеры стилей написания
Рекомендация | Предпочтительно использовать | Не рекомендуется использовать |
Используйте глаголы в действительном залоге, а не в пассивном | Выключить питание | Убедитесь, что напряжение отключено |
Используйте более агрессивные выражения для указаний, а не мягкие формы | Не удалять вкладки | Вкладки не должны быть удалены |
Фразы стройте вокруг глаголов действия, а не абстрактных существительных | Использовать, обслуживать избегать | Использование, обслуживание, избегание |
Обращайтесь непосредственно к пользователям, а не говорите, что они могли бы что-либо сделать | Потянуть черный рычаг на себя | Пользователи будут тянуть черный рычаг в сторону от машины |
Избегайте использования двойного отрицания | Использовать только предохранители на 3 А | Не используйте других предохранителей, кроме как на 3 А |
Избегайте ситуаций, когда легко спутать слова (в частности, с префиксами, которые выглядят и звучат одинаково) | Легковоспламеняющееся содержимое. Высокая (или низкая) чувствительность | Способное к воспламенению содержимое. Гипер (или гипо) чувствительность |
6.1.8 Стандартизированные знаки безопасности и графические символы
В случае необходимости может быть рассмотрено использование стандартизированных знаков безопасности по ISO 7010 или использование на оборудовании графических символов по IEC 60417 и ISO 7000 для передачи важных предупреждающих сообщений.
6.1.9 Принципы эргономики
Инструкции по применению, представляемые с использованием электронных носителей информации, например, в режиме онлайн или в виде документации на экране (см. 6.7), должны соответствовать требованиям стандартов серии ISO 9241.
6.1.10 Удерживание внимания читателей
Если читатели найдут выражения, которые их раздражают, то они будут отвлекаться от процесса усвоения информации. В худшем случае они могут вообще прекратить чтение или проигнорировать весь текст.
Неуважительных, предвзятых или покровительственных выражений, предположений или стереотипов следует избегать, например, тех, которые относятся к пожилым людям, пользователям с ограниченными возможностями, гендерным ролевым стереотипам или предположениям о семейной/домохозяйственной структуре.
Чрезмерно навязчивые предупреждения не способствуют привлечению внимания читателей. По мере возможности предупреждения должны быть сформулированы таким образом, чтобы они относились к прогнозируемым событиям или ошибкам пользователей. Например, вместо "Не погружайте тостер в воду" рекомендуется указать: "Сохраняйте внутренние части сухими".
Маркетинг и рекламные сообщения (например, излишний повтор или акцентирование на брендах) не должны присутствовать в инструкциях по применению.
Необходимые заявления правового характера, например, заявления, касающиеся ответственности, должны быть четко отделены и располагаться отдельно от другого текста в инструкциях по применению. Они должны быть записаны таким образом, чтобы позволить пользователям следить за смыслом и целью таких заявлений.
6.1.11 Корректура
Инструкции по применению должны быть вычитаны другими лицами, кроме составителя или переводчика, предпочтительно лицами, говорящими на языке окончательного текста и знающими рассматриваемый продукт.
Критериями оценки являются:
- формулировки в соответствии со стилем руководства;
- грамотная орфография и пунктуация;
- правильная грамматика;
- непротиворечивость терминов.
6.2 Разборчивость
6.2.1 Размеры шрифтов текста и графических символов
Текстовые шрифты и графические символы, используемые для представления информации, интегрированной в продукт, в печатных документах и компьютеризованной информации, должны быть максимально четкими и такого размера, чтобы на практике обеспечить оптимальную разборчивость для всех пользователей, в том числе для пожилых пользователей и пользователей с нарушениями зрения.
Рекомендуемые минимальные размеры шрифта текста и графических символа приведены в таблице 2.
Наилучшая разборчивость текста достигается при оптимизации соотношений между по меньшей мере четырьмя следующими переменными: тип шрифта, размер шрифта, количество символов в строке (примерно 70 латинских букв) и межстрочный интервал (не менее 120% от размера шрифта латинских букв).
Приемы, используемые для акцентирования, следует применять с осторожностью, чтобы не снизить разборчивость. Жирный шрифт, подчеркивание, и, если применимо, верхний регистр и курсив могут быть использованы, чтобы подчеркнуть отдельные слова и фразы, но не для выделения целых абзацев или разделов.
Если в инструкциях по применению напечатать какой-либо текст шрифтом с размером меньше 10 пунктов, или же разборчивость снижается за счет других факторов, таких как низкая контрастность, то поставщик должен по запросу бесплатно обеспечить печатную версию с более крупным шрифтом.
Для удобства слабовидящих потребителей поставщики должны предлагать варианты доступа ко всей информации в печатных изданиях с крупным шрифтом, а также альтернативные медиа-средства, например, аудиофайлы или простые текстовые файлы, которые можно читать с помощью шрифта Брайля.
Таблица 2 - Минимальные рекомендуемые размеры шрифтов текста и графических символов
Примечание - Термин "пункт" (сокращенно "п.") является единицей измерения размеров шрифтов и интервалов. Существует несколько видов стандартов. Однако в настоящем стандарте принята единица "DTP пункт", равная 0,353 мм или 1/72 дюйма.
Размер продукта или документа инструкции | Расположение и роль инструкции | Высоко- | Низкоконтрастный цветной текст на белом или черном фоне | Набор сложных знаков (например, знаки иероглифов) | Другие замечания | Графические символы, включая знаки безопасности | ||
Общеупот- | Знаки безопасности | |||||||
Инструкции по применению, рассматриваемые с расстояния до 1 м, напольная продукция | Важная маркировка на продукте | Жирный шрифт 14 п. | Жирный шрифт 16 п. | Рассмотреть возможность использования крупных печатных шрифтов, специально разработанных для людей с нарушениями зрения и позволяющих видеть знаки и ярлыки на расстоянии от 30 до 100 см. | В соответствии с требованиями стандартов или правил. В противном случае по результатам просмотра символов с расстояния, с которого они должны привлекать внимание, или быть узнаваемыми. Высота символов менее 15 мм представляется недостаточной для важной маркировки на продукции | |||
Текст | Шрифт 14 п. | Шрифт 16 п. | ||||||
Инструкции по эксплуатации, одиночные листки и настольная продукция | Важная маркировка на продукте | Жирный шрифт 14 п. | ||||||
Заголовки, фразы предупреждений, десятичные цифры | Шрифт 12 п. | Могут быть использованы гротесковые шрифты | Минимальная высота 5 мм (или шрифт 14 п.) | Минимальная высота 10 мм | ||||
Сплошной текст | Шрифт 10 п. | Шрифт 12 п. | Шрифт 9 п. со 150%-ным межстрочным интервалом | Не использовать графические символы в сплошном тексте | ||||
Портативная (ручная) продукция и многостраничная инструкция | Важная маркировка на продукте | Шрифт 12 п. | Минимальная высота 5 мм | Минимальная высота 10 мм | ||||
Заголовки, фразы предупреждений, десятичные цифры | Шрифт 10 п.
| Шрифт 12 п.
| На этом уровне и ниже использовать только безгротесковые шрифты | Предпочтительна минимальная высота 5 мм; 4 мм/12 п. для очень простых символов | Минимальная высота 10 мм, кроме | |||
Непрерывный текст | Шрифт 9 п.
| Для текста не рекомендуется использовать шрифт меньше 12 п. | Электронные, аудиомедиа- | Не использовать графические символы в непрерывном тексте | ||||
Миниатюрная продукция и упаковка (например, площадь для возможной печати меньше 10 см | Важная маркировка на продукте | Шрифт 8 п.
| Шрифт 8 п. со 120%-ным межстрочным интервалом | (для примера, с Веб-сайта или точки продаж) | Предпочтительна минимальная высота 5 мм; 3 мм для очень простых символов | Минимальная высота 10 мм | ||
Непрерывный текст | Шрифт 6 п.
| Не использовать графические символы в непрерывном тексте |
________________
6.2.2 Максимальный яркостный контраст
Для печатных тиснением или гравировкой инструкций по применению яркостный контраст (отношение коэффициентов отражения яркой и темной областей) должен быть как можно выше.
Требования к контрастности текста, отображаемого на терминалах визуальных дисплеев должны соответствовать ISO 9241-300.
6.2.3 Стандарты разборчивости
Если национальные стандарты содержат подробную информацию и технические требования, касающиеся разборчивости, в частности, соотношения между размером шрифта и дистанцией считывания, то они должны быть приняты во внимание при изготовлении инструкции по применению.
6.2.4 Компоновка
Компоновка должна быть выполнена таким образом, чтобы сделать легко отличимыми различные элементы информации. Текстовые блоки должны иметь соответствующие пропорции и эффективное использование белого поля.
Компоновка должна способствовать дифференциации между различными типами передаваемой информации, например:
- тема (заголовок);
- описание;
- действия;
- предупреждения.
6.2.5 Инструкции по применению на поверхности продукта или упаковки
При размещении инструкции по применению на поверхности продукта, угол между этой поверхностью и вертикальной плоскостью должен быть таким, чтобы надписи были легко доступными для чтения и восприятия пользователями с учетом занимаемого ими положения(й) во время использования изделия. Если продукт предназначен для целевых групп с особыми потребностями, это должно быть учтено при определении местоположения инструкций по применению.
Инструкции по применению на упаковке должны быть видимыми и разборчивыми, когда упаковка находится в вертикальном положении.
Преимущества в отношении долговечности и производства инструкций по применению на самом продукте должны быть сопоставлены с такими недостатками, как потери контрастности и разборчивости. Нанесение инструкций по применению на материал продукта обычно дает более худший результат, чем печать хорошего качества (см. также 6.8.4 о стабильности и видимости предупреждающих сообщений).
6.3 Иллюстрации и пояснительный текст
6.3.1 Качество
Особое внимание должно быть уделено качеству и ясности иллюстраций, а также выбору наиболее информативного варианта среди фотографий, схематических чертежей или иллюстраций, полученному методом машинного проектирования. Информация в иллюстрациях должна дополнять информацию, представленную в других формах, и быть понятной. Иллюстрации не должны быть перегружены информацией. Визуальное представление сложной или конкретной информации должно быть избирательным в том, что они показывают подробно (например, поперечные сечения, виды в разобранном состоянии, концептуальные схемы и комиксы).
В отличие от графических символов, включая знаки безопасности, которые должны быть рассчитаны на немедленное узнавание на расстоянии, иллюстрации должны быть составлены таким образом, чтобы заострить внимание на наиболее важных деталях и пояснить их. Иллюстрации должны быть выбраны или разработаны индивидуально для каждой цели компетентным художником-графиком или техническим иллюстратором.
В соответствующих случаях текст и иллюстрации должны быть использованы совместно, когда они взаимно дополняют друг друга, чтобы сделать инструкции по применению более понятными. Там, где это нужно, иллюстрации и пояснительные тексты должны находиться поблизости друг от друга, чтобы они воспринимались как одно целое (см. также 6.3.4). Информация в иллюстрациях и пояснительном тексте должна быть адекватной и ясной. Последовательность иллюстраций должна быть логичной и понятной. Иллюстрации должны быть понятными на прогнозируемом расстоянии просмотра.
В дополнение к рекомендациям в 4.8.3.1, раскладные иллюстрации, занимающие несколько страниц брошюры или руководства по эксплуатации, должны быть размещены таким образом, чтобы их можно было увидеть рядом с различных страниц текста в разное время.
6.3.2 Последовательность операций
Если описывается последовательность операций, то и в тексте и на иллюстрациях должна быть выдержана та же последовательность. Иллюстрации должны быть расположены как можно ближе к тексту, к которому они относятся, чтобы их можно было просматривать вместе с соответствующим текстом.
6.3.3 Иллюстрации с надписями
Иллюстрации должны быть дополнены надписями. При этом должна соблюдаться четкая взаимосвязь между иллюстрацией(ями) и текстом. Надписи должны быть пронумерованы для организации ссылок из основного текста.
6.3.4 Одна иллюстрация - одна единица информации
Иллюстрации обычно должны предоставлять конкретную информацию, имеющую отношение к описанию соответствующей функции. Иллюстрации или подробные часть(и) их должны быть повторены в соответствующей части(ях) инструкций по применению для оказания необходимой помощи пользователю. Информационной перегрузки в иллюстрациях следует избегать.
Однако в тех случаях, когда увеличение числа иллюстраций представляется громоздким, несколько элементов информации могут быть представлены на одной иллюстрации, если это облегчает понимание (например, изображение в разобранном виде или в разрезе для пояснения несколько этапов процедуры).
6.4 Графические символы, включая знаки безопасности
6.4.1 Графические символы для использования на оборудовании, включая знаки безопасности
Графические символы для использования на оборудовании, в том числе знаки безопасности, должны соответствовать ISO 7010, IEC 60417 и ISO 7000.
6.4.2 Объяснение графических символов
Графические символы, пиктограммы, маркировка и условно-графические обозначения, размещенные на самом продукте или в сопроводительных документах, должны быть объяснены в инструкциях по применению.
6.4.3 Графические символы для схем
Графические символы для схем должны соответствовать IEC 60617 и ISO 14617.
6.4.4 Минимальные размеры графических символов
Минимальные размеры графических символов для различных ситуаций приведены в таблице 2. Они должны быть соблюдены, если только меньшего размера нельзя избежать из-за размеров продукта.
6.5 Использование таблиц
Таблицы часто используют в инструкциях по применению, чтобы представить пользователю информацию в более удобной форме. Таблицы должны быть размещены рядом с соответствующим текстом.
Таблицы используют для различных целей, например, при описании процедур поиска и устранения неисправностей. Они должны быть изложены четко, информативно, представлены в виде логичного дизайна и должны повторяться в случае необходимости.
6.6 Использование соответствующих типов документов
Инструкции по применению должны использовать те типы документов, которые подходят лучше по назначению. Обзор установленных типов документов приведен в IEC 61355. Должны быть использованы действующие типы документов для заводов, систем и оборудования.
Примеры:
- когда определенная последовательность операций должна быть задокументирована для безопасного и правильного использования продукта, рекомендуется использовать блок-схему.
- когда установленные функции безопасности продукта должны быть задокументированы, рекомендуется использовать схему соединений и выделить на ней связанные схемы.
6.7 Использование электронных средств информации
6.7.1 Общие положения
К электронным средствам информации относятся любые виды средств связи, которые могут быть использованы для передачи содержимого документов в виде экранных дисплеев и/или аудиоустройств. К ним относятся:
- источники звука;
- видеоисточники;
- комбинированные видео- и аудиоисточники;
- печатные версии документов, которые можно читать на экране через формат обмена файлами и в которых расположение информации совпадает с печатной версией;
- интерактивные мультимедийные приложения, которые сочетают статические элементы, например, текст и изображение, с динамическими элементами, например, видео-, аудио-, анимации, динамические символы, разговорный язык. Они могут функционировать одновременно и пользователи могут управлять ими интерактивно;
- онлайн системы контекстно-зависимой помощи. Они могут содержать элементы интерактивных мультимедийных приложений, как описано выше. Кроме того, они могут предлагать многочисленные схемы доступа и поиска вариантов;
- сети веб-приложений (например, блоги и вики), которые поддерживают создание сообщений от виртуальной команды или сообщества.
Инструкции по применению, предоставляемые через электронные средства информации, должны максимально использовать преимущества выбранного медиа-средства. Однако, как и печатные инструкции по применению, они должны быть легко понятными для пользователей и соответствовать требованиям настоящего стандарта (например, в отношении языков, разборчивости и иллюстраций).
Доступность является важным фактором для инструкций по применению. Необходимо предпринимать все меры, чтобы все пользователи смогли получить необходимую им информацию. Электронные средства информации должны использовать среду, которая позволяет донести решение до широкой аудитории, но при этом они должны отвечать запросам пользователей, быть простыми в использовании и способствовать пониманию вопросов. Например, аудио- и видео- или мультимедиа DVD-диски должны предоставлять широкий спектр звуковых дорожек и вариантов субтитров, включая функцию языка жестов для потребителей с нарушениями слуха и звукового описания для людей с ослабленным зрением.
Интернет изначально предоставляет доступ к информации пользователям с наибольшим спектром индивидуальных потребностей, но важно, чтобы не допустить случайных препятствий для доступа, например, использования затруднительных методов поиска информации или использования анимации, требующей специального программного обеспечения. Поэтому, когда любую часть инструкций по применению или связанную с ними информацию размещают в Интернете, то оформление инструкций и все необходимые средства поиска к ним должны соответствовать требованиям Рекомендаций по доступности веб-контента (Web Content Accessibility Guidelines (WCAG)), разработанных Консорциумом Всемирной Паутины (W3C
Если инструкции по применению предоставляются только в электронном виде (то есть без доступной печатной версии), то об этом должно быть четко разъяснено в точке продажи и на упаковке, вместе с медиа-форматом и типом плеера, необходимым для доступа к инструкциям по применению (например, персональный компьютер, CD-аудио- или DVD-видеоплеер).
Примечание - Правовые нормы иногда могут потребовать наличия распечатанных инструкций, поставляемых вместе с продукцией.
6.7.2 Дидактические требования
Дидактические преимущества электронных средств информации, по сравнению с печатными средствами, должны быть полностью использованы для достижения наилучшего результата общения. Однако следует соблюдать осторожность, чтобы не перегружать пользователей продолжительностью, плотностью информации или сложностью электронных потоков информации.
Поэтому:
- инструкции в электронных средствах информации должны следовать порядку действий, которые пользователь должен выполнить;
- если должны быть объяснены сложные процессы, например, связанные с трудными задачами технического обслуживания и ремонта, то подходящая последовательность передачи зрительных и слуховых элементов сообщения могут облегчить понимание пользователем;
- требования для передачи информации о системе безопасности с помощью электронных средствах информации, особенно в мультимедийных приложениях, должны быть такими же, как для печатных средств информации (см. 6.8).
Анимационные потоки могут включать некоторое количество другой визуальной информация, чтобы сократить их до основных необходимых функций. Анимационные потоки должны сопровождаться синхронной речью или письменным текстом.
Если в электронные средства информации включены рекламные сообщения, то последние должны быть четко отделены от инструкций по применению, и просмотр таких сообщений не должен быть обязательным до просмотра инструкций по применению.
6.7.3 Требования к загружаемым инструкциям по применению
Загружаемые инструкции по применению должны быть предоставлены в форме, которая позволяет отображать их без дальнейших изменений на часто используемых операционных системах и устройствах для чтения. В этом случае веб-сайты, с которых инструкции по применению могут быть загружены, обязаны:
- предоставить либо необходимое программное обеспечение, либо ссылку для загрузки необходимого для просмотра программного обеспечения;
- разрешить загрузку в любое время.
6.7.4 Требования к взаимодействию с пользователем
Электронные медиа-приложения используют преимущества динамической системы поиска и представления средств для облегчения быстрого определения, понимания и, при необходимости, печати необходимой информации. Поэтому:
- электронные медиа-приложения должны предоставлять систему поиска (желательно древовидную), которая способствует свободному перемещению пользователя внутри приложения, а также доступ ко всем отдельным частям приложения. Должны быть узловые точки, облегчающие пользовательскую ориентацию и позволяющие вернуться к фиксированным отправным пунктам в любое время;
- должны быть предусмотрены соответствующие элементы навигации, такие как меню, кнопки, гиперссылки, навигационные цепочки и закладки, позволяющие пользователю ориентироваться и взаимодействовать с системой. Кроме того, отправными точками для подменю могут служить так называемые горячие точки, то есть области для интерактивного общения;
- специально для онлайновых приложений помощи, а также и для других современных мультимедийных приложений, доступ к темам может быть реализован с использованием электронных функций поиска. Наиболее важными из них являются оглавление, поиск по ключевым словам, полнотекстовый поиск, естественно-языковой поиск и поиск по характерным словам;
- чтобы обеспечить ясность компоновки для обширных разделов текста, тексты должны быть закреплены за интерактивными подзаголовками (горячими точками). При необходимости, пользователь может активировать эти точки и таким образом отображать или скрывать отдельные участки текста;
- электронные версии могут быть снабжены функцией печати для распечатывания документов, а также онлайновыми приложениями для организации помощи. Версия для печати должна адаптироваться или исключать элементы мультимедийных приложений и динамические элементы веб-страницы, которые не могут быть распечатаны на листе;
- программное обеспечение инструкций по применению должно быть, насколько это возможно, интегрировано в пользовательский интерфейс. Если интеграция невозможна, например, из-за объемной информации, доступ должен осуществляться непосредственно, например, с помощью кнопки справки.
6.8 Создание визуально заметных сообщений по безопасности
6.8.1 Создание визуально заметного текста
Информация по безопасности должна быть акцентирована путем использования шрифта большего размера и/или шрифта другого типа (см. 6.2.1), при помощи цвета (см. 6.9), путем использования графических знаков безопасности (см. 6.4) или других средств, которые делают ее более заметной.
6.8.2 Создание заметных иллюстраций
Иллюстрации в информации о системе безопасности должны быть акцентированы путем использования цветов, форм, позиционирования (см. 6.3) или других средств, которые делают их более заметными.
Упаковка и контейнеры с опасными веществами могут потребовать тактильного предупреждения об опасности, если имеется вероятность, что содержимое будет неправильно употреблено людьми, не способными увидеть визуальное предупреждение. В этих случаях применяют ISO 11683.
6.8.3 Дизайн и размещение предупреждающих сообщений
Предупреждающие сообщения должны быть намеренно спроектированы таким образом, чтобы быть визуально заметными. При проектировании предупреждающих сообщений, должны быть приняты во внимание следующие аспекты, позволяющие достичь максимальной эффективности:
- начинать сообщение с сигнальных слов (см. 6.8.6);
- ограничить текст и/или иллюстрации по возможности;
- сделать расположение, содержание и стиль предупреждающих сообщений визуально заметными в соответствии с 6.2;
- обеспечить, чтобы предупреждения могли видеть как пользователи, так и любые другие люди, подвергающиеся опасности, со своего местоположения во время использования продукта (см. также 6.2.5), причем в нужное время;
- объяснить природу опасности и, при необходимости, ее причину;
- дать четкие указания о том, как избежать конкретной опасности;
- разместить предупреждающее сообщение, как это определено в ходе оценки рисков. Излишне частое повторение предупреждающих сообщений может снизить их эффективность;
- указать возможные последствия при реализации опасности, не умаляя тяжести последствий.
6.8.4 Стабильность и визуальная заметность
Предупреждающие сообщения об особых опасностях, связанных с повышенным риском при несоблюдении инструкций по применению, должны быть стабильно четко видны пользователям в течение срока службы продукта. Если в предупреждающих сообщениях используются цвета, то должно быть принято во внимание их обесцвечивание и выцветание с течением времени.
6.8.5 Создание визуально заметных предупреждающих сообщений
Предупреждающие сообщения об опасности или ограничениях на использование (например, НЕ ПОДХОДИТ ДЛЯ ДЕТЕЙ В ВОЗРАСТЕ ДО ТРЕХ ЛЕТ) имеют решающее значение для безопасности и должны быть сделаны визуально заметными не меньше, чем другие указания, в документах, передаваемых вместе с продуктом.
6.8.6 Сигнальные слова
Сигнальные слова приведены в ISO 3864-2, к ним относятся:
ОПАСНОСТЬ: сигнальное слово, которое указывает на опасную ситуацию с высоким уровнем риска, которая, если ее не предотвратить, может привести к серьезным травмам или смерти;
ПРЕДУПРЕЖДЕНИЕ: сигнальное слово, которое указывает на опасность со средним уровнем риска, которая, если ее не избежать, может привести к серьезным травмам или смерти;
ВНИМАНИЕ: сигнальное слово, которое указывает на опасную ситуацию с низким уровнем риска, которая, если ее не избежать, может привести к травме легкой или средней тяжести.
Обычный предупреждающий знак, в соответствии с ISO 3864-2, состоит из равностороннего треугольника охватывающего восклицательный знак, с применением цветов безопасности в соответствии с ISO 3864, ему должно предшествовать соответствующее сигнальное слово: ОПАСНОСТЬ, ПРЕДУПРЕЖДЕНИЕ, ВНИМАНИЕ.
6.9 Цвета
6.9.1 Согласованность
Использование цветов должно быть последовательным, функциональным и систематичным. Если инструкции по применению включают знаки безопасности в цвете, то эти знаки должны соответствовать требованиям, в том числе в отношение цвета, указанным в стандартах серии ISO 3864.
6.9.2 Роль цвета в восприятии
Следует иметь в виду, что значительный процент пользователей имеют несколько нарушенное цветоощущение. Поэтому информация не должна быть представлена с использованием одного только цвета, цвет является дополнительным средством для оформления инструкций по применению и для улучшения их восприятия.
6.9.3 Указания по ксерокопированию и печати
При выборе цвета необходимо отдавать предпочтение контрастным цветам, которые будут различимы даже после черно-белого ксерокопирования и печати на черно-белом принтере.
7 Оценка соответствия настоящему стандарту
7.1 Заявление о соответствии настоящему стандарту
Заявления о соответствии настоящему стандарту должны учитывать, в какой мере поставщик предоставил доказательства того, что инструкции по применению (включая информацию по безопасности) были оценены путем экспертной или эмпирической оценки, например, тестированием на применимость в соответствии с требованиями и рекомендациями, приведенными в приложениях А, В и С настоящего стандарта.
В контрольном перечне приложения В перечислены типы и элементы информационного содержания, которые необходимо (в зависимости от вида продукта) предоставить некоторым или всем пользователям через посредство инструкций по применению. Соответствие может быть отмечено последовательной простановкой галочек в тех пунктах, которые адекватно отражены в инструкции.
В контрольном перечне приложения С приведены критерии для оценки эффективности инструкций по применению в отношении передачи информации и прогнозирования ее эффективности в оказании влияния на поведение пользователей. Для большинства видов продукции 100%-ная эффективность инструкций по применению не может быть ни достигнута, ни измерена качественно, поэтому на практике оценки должны быть основаны на субъективных суждениях. Контрольный перечень может быть также использован в качестве руководства для критической оценки отдельных пунктов в инструкциях по применению, которые не представляются эффективными, а не только как перечень критериев, по которым оценивают соответствие документа в целом. Конструктивная критика должна содержать конкретную информацию о разделе, нуждающемся в улучшении, и причины, почему он не признается эффективным (желательны также рекомендации по корректировке, чтобы сделать его эффективным).
Перечень не следует считать исчерпывающим для продукта каждого вида. Его, возможно, нужно дополнять и/или изменять в соответствии с соответствующими стандартами на продукт или (при отсутствии таких стандартов) в соответствии со стандартами на сопоставимую продукцию или на выполняемые функции или любым другим подходящим способом.
Если требуется подтверждение соответствия предъявляемым требованиям третьей стороной в форме сертификации (будь то на основании требований законодательства, стандартов на продукцию или условий договора), в сертификатах указывается:
- тот факт, что документальные доказательства (то есть исследовательские отчеты или отчеты об оценке) были представлены поставщиком после проведения оценки инструкций по применению;
- получены ли доказательства, упомянутые выше, на основании экспертной оценки или эмпирической оценки;
- наименование органа или лица, которые проводили эти оценки.
7.2 Документальное подтверждение оценки
В исследовательских отчетах или отчетах о проведении оценки должно быть указано:
- тот факт, что инструкции по применению и розничная упаковка были представлены на экспертизу;
- язык инструкций по применению, которые были оценены и одобрены в соответствии с настоящим стандартом;
- был ли образец продукта поставлен в полной комплектации или был укомплектован только в части оценки инструкций по применению;
- какие аспекты оценки были основаны на экспертных исследованиях и какие на эмпирической оценке;
- наименование органа или лица (лиц), проводивших оценки;
- наименование органа или лица (лиц), ответственных за проверки и верификацию перевода.
Никакое заявление о соответствии требованиям настоящего стандарта не должно приниматься, пока инструкции по применению не будут оценены квалифицированными экспертами. Эти эксперты не должны были ранее принимать участие в написание инструкций по применению или в разработке, проектировании, производстве или маркетинге данного продукта. См. также приложение А.
Примечание - В зависимости от сложности изделия и степени, в которой безопасное и правильное использование зависит от передачи информации пользователю, инструкции по применению, возможно, должны быть оценены на этапе разработки и/или может возникнуть потребность во внутренней оценке и корректировке проектов инструкций по применению для их оптимизации, прежде чем они будут представлены третьей стороне для оценки.
Приложение А
(обязательное)
Оценка инструкций по применению
А.1 Общие положения
Инструкции по применению должны быть оценены в соответствии с критериями, изложенными ниже.
А.2 Выбор методологии проведения оценки
В зависимости от сложности продукта и важности передачи соответствующей информации пользователям в целях обеспечения безопасной и правильной эксплуатации, оценка должна быть проведена в форме:
- исследования за столом экспертами, не участвовавшими в разработке продукта;
- интерактивной эмпирической оценки инструкций по применению посредством группового опроса потенциальных пользователей и/или целевой группы (групп);
- сочетания того и другого метода.
А.2.1 Исследование экспертами за столом
Только квалифицированные специалисты, никак не связанные с любым аспектом проектирования, производства или сбыта продукта и его инструкции по применению, могут проводить оценку по методу исследования за столом.
Реальный продукт (желательно в упаковке) должен быть доступен для исследователя или независимого эксперта, а не только информация об инструкции на носителе.
Проверки на полноту должны проводиться в соответствии с перечнем приложения В.
Проверки на эффективность должны проводиться в соответствии с перечнем приложения С.
В случае исследования экспертами за столом может оказаться необходимым дополнить его независимыми выездными проверками; например, если предоставление информации в точке продажи является обязательным требованием.
Эффективность каждого перевода должна быть проверена считкой и оценена понятность и точность языка с использованием соответствующих критериев, перечисленных в контрольном перечне приложения С в качестве ориентира для комментариев.
А.2.2 Эмпирическая оценка потенциальными пользователями и/или целевой группой (группами)
См. приложение Е для руководства по эмпирическим методам.
Приложение В
(справочное)
Контрольный перечень для оценки соответствия и комментариев
Примечание - Контрольный перечень, содержащийся в таблице В.1, не является исчерпывающим.
Таблица В.1 - Контрольный перечень для оценки соответствия и комментариев
Позиции, подлежащие проверке | Соответствующий пункт | Соответ- | Коммен- |
1 Идентификация | 4.8.1, | ||
2 Технические характеристики продукта и его потенциальные опасности | 4.3, 4.5, | ||
2.9 Ожидаемый срок службы продукта и предусмотренное обслуживание | |||
3.1 Меры предосторожности перед установкой | 5.8 | ||
4 Функционирование продукции | 5.9 | ||
4.2 Дополнительные функции (идентично пункту 4.1) | |||
5 Информация, необходимая пользователю | 4.8.2.4,
| ||
6 Техническое обслуживание продукта | 5.10 | ||
7 Критические моменты безопасности и медико- | 7.6, 5.5, 6.8 | ||
8 Согласованность в дизайне информации и предложенного "продукта" в целом | 4.1.2, 4.1.3, 4.7.2, 5.15, 6.1, 6.2.5 |
Приложение С
(справочное)
Контрольный перечень для проверки эффективности коммуникации
Перечень, содержащийся в таблице С.1, предлагает критерии для субъективной оценки каждого пункта оцениваемой инструкции по применению, например, каждое предупреждение на продукте, каждый абзац в информационных листках и каждый график. Необходимо только записать комментарии по пунктам или разделам, нуждающимся в улучшении. Такие оценки должны быть приведены с указанием причин, почему товар не считается эффективным (и, желательно, с указанием, что может быть изменено для повышения эффективности).
Примечание - Указанный перечень не является исчерпывающим.
Таблица С.1 - Контрольный перечень для проверки эффективности коммуникации
Вопросы, которые, возможно, должны быть рассмотрены | Соответствующий пункт | Оценка | Коммен- | |
1 | Целевые группы | 4.1.1, 4.4, 4.7.3, 4.8.2, 4.8.3, 5.14.1, 6.2.5 | ||
1.1 | Подробный перечень целевых групп | |||
1.2 | Инструкции по применению адекватно представлены для целевой группы (групп) | |||
2 | Расположение и среда | 4.7.2, 5.15, 6.1.1, 6.7 | ||
2.1 | Размещение на продукте, на упаковке или на сопроводительных электронных носителях информации удовлетворяет требованиям доступности и долговечности | |||
2.2 | Функция оповещения в соответствии с потребностями пользователя (заметность, расстояние видимости и т.д.) | |||
2.3 | Правильность размещения или последовательность по отношению к другой информации, следуя принципам коммуникации | |||
2.4 | Группирование под соответствующим заголовком и возможность поиска по индексу | |||
2.5 | Инструкции по применению и поддерживающие средства массовой информации на веб-сайте поставщика для пользователей, нуждающихся в дополнительной информации | |||
3 | Читаемость текста | 6.2 | ||
3.1 | Разборчивый шрифт и адекватный размер шрифта (в зависимости от расстояния чтения) | |||
3.2 | Длина строки и межстрочный интервал | |||
3.3 | Контраст с фоном | |||
3.4 | Эффективное использование белого пространства | |||
3.5 | Долговечность и разборчивость текста на продукции (или на упаковке) | |||
4 Формулировки и структура текста | 5.15, 6.1 | |||
4.1 Текст/фразеология | ||||
- Слова и фразы не сложные или не чрезмерно сложные | ||||
- Короткие фразы | ||||
- Одно предложение-одно указание. Не слишком много информации в одном предложении | ||||
- Прямой действительный залог и указания в утвердительной форме | ||||
4.2 Термины для описаний функции и действий пользователей | ||||
4.3 Принципы коммуникации | ||||
5 Многоязычность | 4.8.3 | |||
6 Иллюстрации | 6.3 | |||
7 Использование графических символов | 6.1.8, 6.2.1, 6.2.5, 6.4 | |||
8 Таблицы, концептуальные диаграммы и блок-схемы | 6.5, 6.6 | |||
9 Использование цветов | 6.9 | |||
10 Объяснение визуальных и звуковых сигналов | 4.8.2.4, 5.9.4 | |||
11 Инструкции по применению на электронных носителях информации | 6.7 | |||
11.3 Предложены многоязычные варианты текстовой и аудиоинформации | ||||
12 Долговечность | 4.7.4 |
Приложение D
(справочное)
Планирование подготовки инструкций по применению
D.1 Общие положения
Настоящее приложение содержит рекомендации по планированию подготовки инструкции по применению. Рекомендации приведены в виде примере плана, включающего типичные способы подготовки инструкции по применению от замысла до публикации, и состоящего из трех этапов: планирование, разработка и оптимизация.
D.2 Ограничения при планировании подготовки
Время, ресурсы и приоритетность подготовки инструкций по применению может повлиять на качество и эффективность представленной информации для пользователей (например, если планирование не началось, когда продукт находился еще в производстве, или авторы оказались неподготовленными или оценка проведена поверхностно). Ответственность высшего руководства состоит в том, чтобы организовать ресурсы, спланировать время и целевые показатели качества для эффективного проведения планирования, подготовки и реализации инструкций по применению.
а) Высшее руководство должно обеспечить, чтобы разработка инструкций по применению велась параллельно с разработкой проекта продукта и его маркетинга, например:
- выбор среды или носителей информации, которые будут использоваться для передачи инструкций по применению, осуществляется на ранней стадии проектирования процесса (см. 4.7.3);
- перечень пунктов конкретного содержания, которые должны быть включены (инструкции, предупреждения и информация о пользователях - см. раздел 5) может формироваться на всех этапах разработки продукта;
- в тех случаях, когда информация должна быть нанесена на продукт, должны быть учтены в внешний дизайн и свойства поверхности продукта и упаковки (см. раздел 6.2.5).
b) Высшее руководство должно организовать проверку (через посредство кадровых ресурсов и внешних консультантов) наличия всех навыков и опыта, необходимых для подготовки инструкций по применению.
- В зависимости от продукта, они могут включать в себя:
- техническую документацию;
- ошибки человека/результаты эргономической экспертизы;
- создание графики;
- дизайн/создание электронных учебных медиа-средств;
- глубокое понимание развития продукта и предполагаемых функций;
- научные/технические знания и опыт, необходимые для анализа опасностей и предвидения повреждений, износа и неисправности, возникающих во время эксплуатации;
- соблюдение правовых норм и опыта ответственности за качество продукции;
- технически компетентный перевод для каждого языка, предназначен для использования.
Составитель инструкции по применению, изначально не знакомый с продуктом, но владеющий языком целевой группы, будет в лучшем положении, чтобы принимать во внимание потребности пользователей-новичков.
с) Высшее руководство должно выбрать (на ранней стадии) метод оценки проектов инструкций по применению и агентство или лиц, которые в состоянии своевременно провести оценку без задержки производства, упаковки или нарушения правовых и договорных требований.
D.3 Планирование подготовки в деталях (пример)
Один пример не может дать всеобъемлющую информацию, охватывающую все возможные требования, поэтому каждый приведенный здесь шаг должен быть проверен на соответствие требованиям в зависимости от сложности, риска, правовых вопросов и т.д. Это пример для довольно масштабного и комплексного проекта, тем не менее он может оказаться полезным составителям инструкции по применению и для более простых продуктов, иллюстрируя ряд процессов, которые, возможно, должны быть запланированы.
В процессе создания инструкций по применению должны быть рассмотрены нескольких этапов. Ниже описаны шаги, которые могут гарантировать, что инструкции по применению глубоко продуманы и способны предоставить пользователям необходимую им информацию. Шаги, описанные в настоящем разделе, предназначены для адаптации и дополнения в соответствии с требованиями в части разработки инструкций по применению.
а) Анализ, определение общих условий
Для удовлетворения всем требованиям и получения гарантии в том, что инструкции по применению удовлетворяют поставленным целям, должны быть проанализированы соответствующие источники информации, такие как требования законодательства, договоров и стандартов. Это обеспечит основу для подготовки перечня требований, которым инструкции по применению должны удовлетворять. Следующие вопросы должны быть проанализированы:
- продукт, к которому относятся инструкции по применению: цель и функции продукта, аналогичные продукты и их инструкции по применению, структура продукта, остаточные риски (на основании оценки риска), возможные проблемы и устранение неисправностей, запасные части и опции, контроль и оценка соответствия, срок службы продукта;
- предложенный рынок (рынки), куда продукт будет поставляться для использования: характеристики рынка(ов), каналы распределения продукта;
- все правовые и нормативные требования для всех рынков, которые должны быть выполнены. Обычно о правовых и нормативных документов*, которые распространяются на продукт, известно разработчику продукта;
________________
* Текст документа соответствует оригиналу. - .
- соответствующие целевые группы: предполагаемые пользователи, и другие лица, которых намечено проинструктировать по использованию данного продукта.
После завершения приведенного выше анализа до начала подготовки документации должен быть составлен подробный перечень требований.
b) Планирование и управление проектом
Разработка инструкций по применению требует специального управления проектом и наличия проекта коммуникаций. Задачи, обязанности, санкционирование и этапы должны быть четко определены. Редакционный крайний срок может быть полезным для того, чтобы обеспечить предоставление вовремя всей соответствующей информации.
c) Концептуальное проектирование
Инструкции по применению должны быть разработаны на основе хорошо спланированной концепции. Концепция необходима, чтобы гарантировать согласованность и доступность информации.
К элементам концептуального проекта относятся, в основном, следующие:
- принципы и определения предполагаемого качества информации;
- тип и структура документов, призванных предоставить пользователю оптимальный доступ к информации;
- комбинация более чем одного документа, если это применимо;
- использование текста, типы визуализации и согласование текста и визуализации;
- концепция медиа-средств;
- компоновка медиа-средств и навигация;
- типы информации (например, последовательность действий, описание компонента, описание экрана, план обслуживания, таблица неисправностей, указания по технике безопасности, предупреждающие сообщения) и соответствующие коммуникационные модели (определение, структура, фразировка и авторские права);
- если инструкции по применению состоят из информационных модулей, то описание и типы модулей;
- способы использования ссылок и связей;
- концепция одного источника, если это применимо;
- язык и общие правила построения текста;
- терминология и ее использование в инструкции по применению;
- глоссарий и индексация там, где терминология имеет особую важность;
- глобализация и интернационализация, подготовка к переводу и локализации.
Концепция должна быть определена и хорошо объяснена на отработанных и испытанных образцах во внутрифирменном руководстве по стилю. Если инструкции по применению должны разрабатываться группой технических специалистов и/или в течение продолжительного периода времени, то в этом случае особенно необходимо обеспечить качество и последовательность руководства по стилю и соответствующее обучение технических специалистов. Руководство по стилю должно быть представлено в форме, позволяющей легко использовать его во время редактирования и написания.
Обычно концепцию определяют для серии инструкций по применению. Сама концепция должна периодически корректироваться.
d) Инструкции по применению как часть продукта
Разработка инструкции по применению является неотъемлемой частью разработки и дизайна продукта.
В частности, с точки зрения безопасности, разработчик инструкции по применению должен быть привлечен к оценке рисков, чтобы прояснить требуемый объем инструкции по применению, выработать требования по безопасности конструкции и наладить оптимальное соотношение средств конструирования, таких как, внутренняя безопасность, устройства и оборудование для обеспечения безопасности, дизайн пользовательского интерфейса, а также информация типа предупреждающих сообщений и указаний по технике безопасности, обучение, упаковка.
Должны быть задействованы все имеющиеся источники обратной связи с пользователями для поиска недостатков в инструкциях по применению, которыми снабжена предыдущая аналогичная продукция, например, жалобы клиентов, сервисные отчеты, анализ причин несчастных случаев и травм, а также обзоры продукции, размещенные в Интернете.
Если требуются квалифицированные специалисты для установки, эксплуатации или обслуживания продукта, в тексте должно быть заявлено об этом как об обязательном требовании для обеспечения безопасности и/или по техническим причинам, а также о том, что никакие другие лица не должны эксплуатировать, заниматься техническим обслуживанием и разборкой продукта (см. 5.9, 5.10 и 5.13). Квалификация и навыки, необходимые специалистам, должны быть четко указаны в инструкции по применению или в других письменных документах, имеющих к ней отношение.
e) Исследование
Исследование является решающим фактором в разработке инструкции по применению. По мере возможности продукт должен быть доступен составителям для разработки правильной и адекватной инструкции по применению.
Исследование через интервью должно быть хорошо спланировано. Интервьюируемые разработчики должны иметь необходимые ресурсы и достаточно времени, чтобы передать всю информацию должным образом.
Разработчики продукта должны быть обязаны предоставлять информацию о проведенном изменении продукта. Надлежащий процесс изменения должен быть спланирован таким образом, чтобы инструкции по применению могли быть изменены в случае необходимости.
Следует убедиться, что результаты контроля (например, сбор жалоб, сервисное обслуживание и публикации), влияющие на инструкции по применению, будут приниматься во внимание.
В том случае, когда уже имеющаяся информация должна быть использована повторно, ее необходимо проверить перед публикацией для подтверждения актуальности и точности. При необходимости такая информация должна быть адаптирована.
f) Разработка содержания
Содержание должно быть сформировано на основе концепции и исследования. Главы и разделы должны быть помещены в оглавление. Каждая глава и раздел должны содержать один тип информации. Такой план может служить основой для построения документа из информационных модулей.
Контрольные перечни и инструменты для авторской помощи могут быть полезными для обеспечения правильной терминологии, фразеологии, структуры и полноты информации. Средства разработки и редакторы должны как можно лучше поддерживать авторскую разработку.
Своевременно должны быть выполнены контроль качества и пользовательская проверка версии проекта, чтобы выявить ошибки или избежать их на ранней стадии разработки инструкций по применению.
g) Отзывы о качестве
Инструкции по применению должны быть тщательно проанализированы в соответствии с требованиями и руководством по стилю специалистом в области технической коммуникации или лицом, имеющим по крайней мере 5 лет опыта работы в этой области. Должно быть запланировано достаточное время на это чтение и последующее редактирование.
Должны быть запланированы и реализованы отзывы о технической правильности.
Если требования не соблюдены, то должно быть принято решение о дальнейшем редактировании инструкций по применению. Целью должен быть положительный результат.
h) Обеспечение качества
Эмпирическая оценка (пользовательское тестирование) должна показать, насколько инструкции по применению достигли цели. Пользовательское тестирование должно проводиться в процессе разработки продукта в целом, включая инструкции по применению. Все улучшения должны учитываться в пределах требований, системы обеспечения качества и руководства по стилю, чтобы получить непрерывное повышение качества инструкции по применению. Перечни изменений могут быть использованы для организации улучшений.
i) Перевод
В большинстве случаев перевод не может быть более высокого качества, чем исходный текст. Так что высокое качество и адекватность перевода исходному тексту имеют первостепенное значение для качества и безопасности переведенного текста.
Процесс перевода должен быть хорошо спланированным и управляемым, включая лингвистические и технические обзоры лиц, имеющих необходимые навыки. Должны быть приняты во внимание соответствующие стандарты на услуги по переводу.
j) Тиражирование
Изготовленные (например, отпечатанные) инструкции по применению должны быть доступны в течение ожидаемого срока службы продукта (см. 4.7.4). Печатные инструкции по применению должны быть напечатаны на прочной бумаге.
Приложение Е
(справочное)
Эмпирические методы поддержки подготовки инструкций по применению
Е.1 Общие положения
При подготовке инструкций по применению могут быть использованы различные эмпирические методы:
- опросы общественного мнения (письменные интервью, устные интервью, фокус-группы);
- тестирование на пригодность к использованию;
- самооценка и контрольный перечень;
- экспертизы, экспертные обзоры и сертификация;
- программы независимых премий или поощрений;
- сбор жалоб, горячие линии и сервисная информация.
Е.2 Методы
Е.2.1 Опросы общественного мнения
Таблица Е.1
Письменные интервью | Устные интервью | Фокус-группы | |
Область/цели | Анализ удовлетворенности | Оценка/анализ документации по обращению и работе с инструкцией по применению | Определение потребностей пользователей |
Плюсы | Низкая стоимость | Существенное снижение недоразумений по поводу толкования вопросов | Противоположные мнения могут быть обсуждены |
Минусы | Ограниченная интеграция примеров инструкций по применению | Трудоемкость и относительная дороговизна | Давление группы может ограничить высказывания и сузить перспективы |
Е.2.2 Тестирование на пригодность к применению
Область/цели:
- разработка новых инструкций по применению/документации;
- тестирование инструкций по применению/документации или сравнение различных документов;
- тестирование на удобопонятность и пригодность к использованию.
Плюсы:
надежные результаты о пригодности документации;
быстро обнаруживаются слабые стороны.
Минусы
необходима специальная лабораторная техника;
статистическая репрезентативность результатов должна быть доказана;
сравнительная дороговизна.
Е.2.3 Самооценка и контрольные перечни
Область/цели:
- оценка качества в соответствии с техническими критериями;
- контрольные перечни в соответствии со стандартами.
Плюсы:
дешевизна;
возможность сравнения различных инструкций по применению по одним и тем же критериям;
процесс и изменение с течением времени соответственно могут выявить шаги для оптимизации.
Минусы:
несмотря на объективные критерии оценки, субъективные различия в оценке не может быть исключено*;
________________
* Текст документа соответствует оригиналу. - .
нет информации о клиентах устанавливаемого пожелания и требования и
ноу-хау, необходимых для развития оценки.
Е.2.4 Экспертиза, экспертные обзоры и сертификация
Область/цели:
- оценка инструкций по применению в соответствии с определенными критериями;
- анализ слабых мест;
- договоренности, касающиеся правовых споров.
Плюсы:
экспертная оценка;
варьируемый диапазон критериев испытаний;
определение слабых мест;
сертификация соответствия установленным требованиям.
Минусы:
неспособность обеспечить объективную оценку от одного эксперта;
сравнительно высокая стоимость (комплексной экспертизы/сертификатов);
отсутствует обязательное требование включить предложения по улучшению;
несмотря на сертификат, нет освобождения от ответственности.
Е.2.5 Результаты программы независимой премии или поощрения
Область/цели:
- сертификация высокого качества продукта в соответствии с общепринятыми руководящими принципами;
- конкуренция с другими информационными продуктами.
Плюсы:
независимые эксперты;
низкая стоимость;
сопоставимость результатов оценки с данными других информационных продуктов.
Минусы:
контрольный перечень с критериями не ориентирован на конкретный вопрос или проблему;
не обязательно отражает точку зрения клиента в отношении качества.
Е.2.6 Обратная связь от сбора жалоб, горячих линий и сервисной информации
Область/цели:
- постоянное совершенствование процесса;
- оптимизация обработки вопросов;
- совершенствование информационного продукта.
Плюсы:
постоянная обратная связь;
информация может быть использована для улучшения инструкций по применению;
затраты на горячую линию могут быть уменьшены.
Минусы:
отсутствует систематическая оценка в соответствии с определенными критериями;
нет количественной оценки относительно общей проблемы;
ограничение отрицательных откликов в связи с так называемым самовыбором участников.
Приложение ДА
(справочное)
Сведения о соответствии ссылочных международных стандартов межгосударственным стандартам
Таблица ДА.1
Обозначение ссылочного международного стандарта | Степень соответствия | Обозначение и наименование соответствующего межгосударственного стандарта |
IEC 60204-1:2005 | - | *, |
IEC 60417 | - | * |
IEC 60529 | MOD | ГОСТ 14254-2015 "Степени защиты, обеспечиваемые оболочками (Код IP)" |
IEC 60617 | - | * |
IEC 62507-1 | - | * |
IEC/PAS 62569-1:2009 | IDT | ГОСТ IEC/PAS 62569-1-2014 "Групповые технические требования к информации о продукции. Часть 1. Принципы и методы" |
ISO 3864 (all parts) | - | * |
ISO 3864-2 | - | * |
ISO 7000 | - | * |
ISO 7010 | v** | * |
ISO 9241 (all parts) | IDT | ГОСТ Р ИСО 9241-2012 "Эргономика взаимодействия "человек-система" взаимодействия" |
ISO 11683 | IDT | ГОСТ Р ИСО 11683-2009 "Упаковка. Тактильные предупреждения об опасности. Требования" |
ISO 12100 | IDT | ГОСТ ISO 12100-2013 "Безопасность машин. Основные принципы конструирования. Оценки риска и снижения риска" |
ISO 14617 (all parts) | - | * |
ISO/IEC Guide 51:1999 | - | * |
ISO/IEC Guide 71:2001 | - | * |
* Соответствующий межгосударственный стандарт отсутствует. До его принятия рекомендуется использовать перевод на русский язык данного международного стандарта. |
_______________
Библиография
IEC 60073, Basic and safety principles for man-machine interface, marking and identification - Coding principles for indicators and actuators (Основополагающие принципы и принципы безопасности для интерфейса человек-машина, маркировка и идентификация. Принципы кодирования для индикаторов и приводы)
IEC 60848, GRAFCET specification language for sequential function charts (Спецификация языка для последовательных функциональных схем)
IEC 61082-1:2006, Preparation of documents used in electrotechnology - Part 1: Rules (Подготовка документов, используемых в электротехнике. Часть 1. Правила)
IEC 61310-1, Safety of machinery - Indication, marking and actuation - Part 1: Requirements for visual, acoustic and tactile signals (Безопасность машин. Индикация, маркировка и приведение в действие. Часть 1. Требования к визуальным, звуковым и тактильным знакам)
IEC 61355-1:2008, Classification and designation of documents for plants, systems and equipment - Part 1: Rules and classification tables (Классификация и обозначение документов для растений, системы и оборудование. Часть 1. Правила и классификационные таблицы)
IEC 80416-1:2009, Basic principles for graphical symbols for use on equipment - Part 1: Creation of symbol originals for registration (Основные принципы для графических символов для использования на оборудовании. Часть 1. Создание графических символов для регистрации)
IEC 81346-1, Industrial systems, installations and equipment and industrial products - Structuring principles and reference designations - Part 1: Basic rules (Промышленные системы, установки и оборудование и промышленные товары. Структурные принципы и условные обозначения. Часть 1. Основные правила)
ISO/IEC 80000 (all parts), Quantities and units [(все части). Количества и единицы]
ISO/IEC Guide 14:2003, Purchase information on goods and services intended for consumers ISO/IEC Guide 37, Instructions for use of products by consumers (Покупка информации о товарах и услугах, предназначенных для потребителей в Руководстве ИСО/МЭК 37. Инструкция по применению продуктов потребителями)
Руководство ИСО/МЭК 74, Graphical symbols - Technical guidelines for the consideration of consumers' needs (Графические символы. Технические руководящие принципы для рассмотрения нужд потребителей)
ISO 9186 (all parts), Graphical symbols - Test methods [(все части). Графические символы. Методы испытаний]
ISO 10628, Flow diagrams for process plants - General rules (Технологические схемы технологических установок. Общие правила)
ISO 11429, Ergonomics - System of auditory and visual danger and information signals (Эргономика. Система слуховых и зрительных опасностей и информационные сигналы)
ISO 15006, Road vehicles - Ergonomic aspects of transport information and control systems - Specifications and compliance procedures for in-vehicle auditory presentation (Автотранспортные средства. Эргономические аспекты транспортной информации и систем управления. Технические характеристики и соблюдения процедур в автомобиле слуховых презентаций)
ISO/TR 16352, Road vehicles - Ergonomic aspects of in-vehicle presentation for transport information and control systems - Warning systems (Автотранспортные средства. Эргономические аспекты представления транспортной информации и систем управления внутри транспортного средства. Системы оповещения)
Web Content Accessibility Guidelines (WCAG) 2.0, В. Caldwell, M. Cooper, L. Reid, G. Vanderheiden, Editors, W3C Recommendation, 11 December 2008 (Web Content Accessibility Guidelines (WCAG) 2.0 Колдуэлл Б., Купер М., Рида
Л., Vanderheiden Г., редакторы, рекомендация W3C 11 декабря 2008 г.
УДК 61:006.354 |
| МКС 01.110 | |
29.020 | |||
Ключевые слова: техническая документация, инструкция по применению, разработка |
Электронный текст документа
и сверен по:
, 2020