Интерактивная документация что это
Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.
Традиционно в России для поддержки эксплуатации сложных промышленных изделий применяют бумажную документацию. Но, в связи со стремительным ростом сегмента IT-технологий все чаще находит применение интерактивная техническая документации в электронном виде. Такие электронные документы, содержащие в себе сведения об изделии, его составе, устройстве, принципе работы, составе ЗИП, процедурах технического обслуживания, анимацию или видео по сборке/разборке/обслуживанию принято сокращенно называть ИЭТР.
ИЭТР – это интерактивное электронное техническое руководство.
В ГОСТ Р 50.1.030-2001 по функциональным возможностям выделено четыре основных класса ИЭТР.
Также некоторые разработчики выделяют и ИЭТР 5-го класса, среди особенностей выделяя возможность построения различного рода прогнозов, использования инструментов анализа и построения рекомендаций для потребителя, но на текущий момент времени в российских стандартах существует только 4 основных класса ИЭТР.
Разработка ИЭТР в SolidWorks Composer
Разработка интерактивных руководств в нашей компании ведется при помощи программного обеспечения SolidWorks Composer – мощного продукта для создания интерактивных и маркетинговых материалов на базе конструкторских разработок.
Основные преимущества использования SolidWorks Composer для разработки ИЭТР:
Для просмотра результатов нашей работы не нужно приобретать специальное программное обеспечение – для работы с 3D моделями, анимацией и видео в составе ИЭТР уже есть электронная система отображения (ЭСО) – Composer Player, встроенная в файл ИЭТР.
Сквозной подход к проектированию не потребует разработки ИЭТР заново при изменении модели или чертежа, достаточно обновить модель и модули данных и содержание ИЭТР перестраивается автоматически – меньше затрат на сопровождение и корректировку документации.
Большая Энциклопедия Нефти и Газа
Интерактивный документ
Интерактивный документ может состоять из нескольких отдельных файлов-страниц, каждый из которых может быть как текстовым, так и документом любого другого вида. В зависимости от действий пользователя меняется порядок просмотра, автоматически открываются другие документы или воспроизводятся мультимедийные файлы. [1]
Интерактивный документ обычно отображается специальной программой, используемой в качестве средства просмотра. Именно эта программа и обеспечивает обратную связь с пользователем: воздействие пользователя на активные элементы документа ( например, на гиперссылки или командные кнопки) вызывает соответствующую реакцию этой программы. [2]
Многие электронные документов являются интерактивными. Интерактивный документ отличается от обычного тем, что порядок работы с документом определяется не только пользователем, но и создателем документа. [7]
Существуют интерактивные документы с развлекательным, обучающим и справочным содержанием. [8]
Электронные каталоги и брошюры часто оказываются более эффективными, чем печатные. Кроме того, разработка интерактивных документов также позволяет параллельно совершенствовать и пополнять существующие печатные материалы. [10]
Электронные каталоги и брошюры часто оказываются более эффективными, чем печатные. Кроме того, разработка интерактивных документов также позволяет параллельно совершенствовать и пополнять существующие печатные материалы. [11]
Интерактивная электронная техническая документация
Преступая к прочтению статьи, посвященной интерактивной электронной технической документации, важно понимать, что интерактивность — это свойство взаимодействия с данными, тогда как первичным было и остается содержание документа. Именно поэтому требования к содержательной составляющей бумажного и интерактивного электронного документа идентичны. Они регламентируются общемашиностроительными (ГОСТ 2.601, ГОСТ 2.602, ГОСТ 2.610), военными (ГОСТ 0002-601-2008, ГОСТ 0002-602-2008) стандартами, а также отраслевыми нормативными документами.
Если содержательная часть интерактивной электронной и бумажной документации идентична друг другу, закономерно возникает вопрос: в чем же тогда особенность интерактивной формы представления документа? Этот вопрос следует рассматривать с двух позиций. Первая — преимущества для разработчика документации. Вторая — преимущества для пользователя.
С позиции разработчика интерактивная электронная документация удобна за счет использования единого источника данных. Это существенно упрощает процесс разработки как на базовое изделие, так и на его модификации. Мы уже писали о преимуществах этого подхода. Однако пользователю интерактивный технический документ дает еще больше преимуществ:
Из вышеназванных преимуществ логично вытекают и другие преимущества интерактивных электронных документов. Их мы рассмотрим ниже, в разрезе требований к ИЭТР.
Требования к ИЭТР
Требования к виду, комплектности, стилю оформления, содержанию и отображению документов основывается на ГОСТ 2.601, ГОСТ 2.602 и ГОСТ 2.610, при этом требования к функциональности ИЭТР в этих стандартах описаны достаточно детально. Также, согласно стандарту в требования к функционалу интерактивной электронной документации включаются следующие группы требований:
ГОСТ 54088 рекомендует сводить требования к функционалу интерактивных электронных документов в единую таблицу, составленную из элементов требований к функциональным характеристикам интерактивных электронных технических руководств (Приложение А). Этой таблицей удобно пользоваться при формировании ТЗ на разработку интерактивной электронной технической документации.
Стоит отметить, что отдельные интерактивные электронные эксплуатационные и ремонтные документы зачастую называют интерактивными электронными техническими публикациями (ИЭТП) или интерактивными электронными техническими руководствами (ИЭТР). Каждый из этих терминов имеет под собой историческую основу, а об отличиях ИЭТР от ИЭТП мы уже писали — посмотрите здесь.
Важно учитывать, что при разработке интерактивной электронной документации первично содержание документа, тогда как форма его представления вторична. В то же время интерактивная электронная техническая документация обеспечивает как пользователю, так и разработчику массу преимуществ. В любом случае, формируя требования к ИЭТР, главным образом, следует учитывать требования ГОСТ 54088 и определять класс ИЭТП с помощью перечня требований технического задания.
У специалистов «Иторум» обширный опыт разработки ИЭТР различной сложности, а профессионализм и инициативность обеспечивают качественный результат в сжатые сроки. Оставьте заявку в форме обратной связи или позвоните по тел. 8495-120-80-55 и мы проконсультируем вас по всем вопросам разработки и использования ИЭТР.
Интерактивная документация что это
НАЦИОНАЛЬНЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ
Интегрированная логистическая поддержка
ИНТЕРАКТИВНЫЕ ЭЛЕКТРОННЫЕ ЭКСПЛУАТАЦИОННЫЕ И РЕМОНТНЫЕ ДОКУМЕНТЫ
Основные положения и общие требования
Integrated logistic support. Interactive electronic maintenance and repair documents. General principles and basic requirements
— Примечание изготовителя базы данных.
Дата введения 2011-09-01
Сведения о стандарте
1 РАЗРАБОТАН Автономной некоммерческой организацией «Научно-исследовательский центр CALS-технологий «Прикладная логистика» (АНО НИЦ CALS-технологий «Прикладная логистика»)
2 ВНЕСЕН Техническим комитетом по стандартизации ТК 459 «Информационная поддержка жизненного цикла изделий»
1 Область применения
Настоящий стандарт предназначен для применения при разработке новых образцов изделий, в том числе изделий, поставляемых отечественным государственным и иностранным заказчикам, а также при организации и совершенствовании процессов технической эксплуатации изделий, включая ранее разработанные и уже используемые изделия.
2 Нормативные ссылки
В настоящем стандарте использованы нормативные ссылки на следующие стандарты:
ГОСТ Р 53393-2009 Интегрированная логистическая поддержка. Основные положения
ГОСТ Р 53394-2009 Интегрированная логистическая поддержка. Основные термины и определения
ГОСТ 2.051-2006 Единая система конструкторской документации. Электронные документы. Общие положения
ГОСТ 2.503-90 Единая система конструкторской документации. Правила внесения изменений
ГОСТ 2.601-2006 Единая система конструкторской документации. Эксплуатационные документы
ГОСТ 2.602-95 Единая система конструкторской документации. Ремонтные документы
ГОСТ 2.603-68 Единая система конструкторской документации. Внесение изменений в эксплуатационную и ремонтную документацию
ГОСТ 2.610-2006 Единая система конструкторской документации. Правила выполнения эксплуатационных документов
ГОСТ 27.002-2009* Надежность в технике. Термины и определения
3 Термины, определения и сокращения
3.1 Термины и определения
В настоящем стандарте применены термины, приведенные в ГОСТ Р 53394, а также следующие термины с соответствующими определениями:
3.1.1 диалоговое окно: Средство запроса, получения и отображения данных, введенных пользователем в ИЭТП.
3.1.2 навигация: Способ просмотра и оперативного нахождения нужных технических данных, содержащихся в ИЭТП.
электронная система отображения: Комплекс программно-технических средств для воспроизведения данных, содержащихся в интерактивном электронном документе.
3.1.4 всплывающая подсказка: Контекстно-зависимая удобочитаемая отметка, которая должна отображаться, когда курсор подводится к графическому объекту или элементу управления.
3.1.5 фильтрация: Метод отображения данных, обладающих определенными признаками (по применимости, актуальности, состоянию и т.д.).
модуль данных: Совокупность взаимосвязанных технических сведений по эксплуатации изделия, относящихся к определенной тематике и не допускающих дальнейшего их дробления на составные части.
3.1.7 логическое ядро: Компонент программного обеспечения, анализирующий введенные пользователем данные.
3.1.8 режим реального времени: Режим обработки данных (как правило, в вычислительной сети), при котором обеспечивается взаимодействие вычислительной системы с пользователем, а также с внешними по отношению к ней процессами в темпе, соизмеримом со скоростью протекания этих процессов.
общая база данных эксплуатационной документации: Автоматизированная система хранения и управления модулями данных, входящими в состав эксплуатационной документации на изделие, позволяющая по запросу получить в электронной или бумажной форме конкретный эксплуатационный документ.
3.1.10 информационный набор: Совокупность информации, представленной в определенном объеме и с необходимой (с точки зрения автора) степенью детализации в виде набора модулей данных, хранимых в ОБДЭ.
3.1.11 публикация: Данные, собранные и подготовленные для передачи заказчику или иным заинтересованным лицам; может быть выполнена в интерактивной электронной или традиционной бумажной форме с использованием модулей данных, содержащихся в ОБДЭ.
3.1.12 модуль публикации: Специальный электронный документ, имеющий согласно ГОСТ 2.051 идентификационно-статусную и содержательную части.
Здесь и далее знаком «*» отмечены пункты, к которым даны комментарии в приложении А.
2 Модуль публикации определяет оглавление и структуру публикации. Он должен содержать одну или более ссылок на:
— модули данных (включая служебные модули данных);
— другие модули публикации;
— заимствованные технические публикации*.
интерактивный электронный документ: Документ, информация содержательной части которого доступна в интерактивной форме.
3.1.14 архитектура «клиент-сервер»: Способ организации вычислительной сети*.
3.2 Сокращения
В настоящем стандарте приняты следующие сокращения:
Интерактивная документация что это
НАЦИОНАЛЬНЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ
Интегрированная логистическая поддержка
ЭКСПЛУАТАЦИОННАЯ И РЕМОНТНАЯ ДОКУМЕНТАЦИЯ В ФОРМЕ ИНТЕРАКТИВНЫХ ЭЛЕКТРОННЫХ ТЕХНИЧЕСКИХ РУКОВОДСТВ
Основные положения и общие требования
Integrated logistic support. Operating and maintenance documentation in interactive electronic technical manuals format. General provisions and general requirements
Дата введения 2018-06-01
Предисловие
1 РАЗРАБОТАН Акционерным обществом «Научно-исследовательский центр «Прикладная Логистика» (АО НИЦ «Прикладная Логистика») и Акционерным обществом «Летно-исследовательский институт имени М.М.Громова» (АО «ЛИИ им.М.М.Громова»)
2 ВНЕСЕН Техническим комитетом по стандартизации ТК 482 «Поддержка жизненного цикла экспортируемой продукции военного и продукции двойного назначения»
3 УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Приказом Федерального агентства по техническому регулированию и метрологии от 29 декабря 2017 г. N 2123-ст
1 Область применения
2 Нормативные ссылки
В настоящем стандарте использованы ссылки на следующие стандарты:
ГОСТ 2.051 Единая система конструкторской документации. Электронные документы. Общие положения
ГОСТ 2.058 Единая система конструкторской документации. Правила выполнения реквизитной части электронных конструкторских документов
ГОСТ 2.503 Единая система конструкторской документации. Правила внесения изменений
ГОСТ 2.601 Единая система конструкторской документации. Эксплуатационные документы
ГОСТ 2.602 Единая система конструкторской документации. Ремонтные документы
ГОСТ 2.603 Единая система конструкторской документации. Внесение изменений в эксплуатационную и ремонтную документацию
ГОСТ 2.610 Единая система конструкторской документации. Правила выполнения эксплуатационных документов
ГОСТ 19.101 Единая система программной документации. Виды программ и программных документов
ГОСТ 25866 Эксплуатация техники. Термины и определения
ГОСТ Р 53392 Интегрированная логистическая поддержка. Анализ логистической поддержки. Основные положения
ГОСТ Р 53394 Интегрированная логистическая поддержка. Термины и определения
ГОСТ Р 54089 Интегрированная логистическая поддержка. Электронное дело изделия. Основные положения и общие требования
3 Термины, определения и сокращения
3.1 Термины и определения
В настоящем стандарте применены термины по ГОСТ 2.051, ГОСТ 25866, ГОСТ Р 53394, а также следующие термины с соответствующими определениями:
3.1.1 интерактивное электронное техническое руководство: Совокупность электронных документов, технических данных и программно-технических средств, предназначенная для информационного обеспечения процессов использования по назначению и технической эксплуатации изделия и (или) его составных частей и предоставляющая пользователям возможность прямой и обратной связи между пользователем и руководством в режиме реального времени с помощью интерфейса электронной системы отображения.
1 Интерактивность отражает способность электронной системы отображения информации обеспечивать диалог с пользователем через пользовательский интерфейс системы путем генерации взаимных запросов пользователем и системой и выдачей ответов на эти запросы. Интерактивность обеспечивается наличием в электронной системе отображения необходимых элементов управления (кнопки, «флажки», поля для ввода данных и т.д.).
3 Программно-технические средства в составе интерактивного электронного технического руководства включают электронную систему отображения и другие необходимые средства (например, драйверы, утилиты шифрования и др.).
3.1.2 электронная система отображения: Комплекс программных и технических средств для воспроизведения данных, содержащихся в интерактивном электронном техническом руководстве.
3.1.3 навигация: Способ просмотра содержания и оперативного поиска с помощью электронной системы отображения необходимых технических данных, содержащихся в интерактивном электронном техническом руководстве.
3.1.4 всплывающая подсказка: Элемент пользовательского (графического) интерфейса электронной системы отображения в виде контекстно-зависимой и легко воспринимаемой пользователем информации (метки, окна и т.п.), отображаемой при подведении курсора к объекту графического интерфейса, при текстовом вводе определенных видов данных или в случае недопустимого действия пользователя.
3.1.5 фильтрация: Способ подготовки для отображения данных, обладающих определенными признаками (по применимости, статусу, виду сведений и т.д.).
модуль данных: Совокупность взаимосвязанных технических сведений по эксплуатации изделия, относящихся к определенной тематике и не допускающих дальнейшего их дробления на составные части.
3.1.7 общая база данных эксплуатационной документации: Автоматизированная система, обеспечивающая получение, хранение, преобразование и сопровождение данных о технической эксплуатации и ремонте изделия и их предоставление потребителям в соответствии с установленными правилами.
2 ОБДЭ представляет собой автоматизированную систему управления данными об изделии применительно к данным об эксплуатации и ремонте изделия.
3.1.8 информационный объект: Минимальный идентифицированный элемент данных в автоматизированной системе, имеющий один или более атрибутов.
3.1.9 автоматизированная система разработки эксплуатационной и ремонтной документации: Автоматизированная система, решающая задачи разработки, подготовки к поставке, хранения, преобразования и предоставления пользователю эксплуатационной и ремонтной документации (в том числе в виде интерактивного электронного технического руководства).
1 Интерактивное электронное техническое руководство как результат работы рассматриваемой автоматизированной системы не входит в ее состав и используется в качестве самостоятельного средства обеспечения применения и технической эксплуатации изделия.
2 Общая база данных эксплуатационной документации является частью автоматизированной системы разработки эксплуатационной и ремонтной документации.
3.1.10 локальная база данных интерактивного электронного технического руководства: Часть данных (модули данных, документы и другие информационные объекты), выделенная из общей базы данных эксплуатационной документации для обособленного использования и хранения в составе интерактивного электронного технического руководства, передаваемого потребителю.
В настоящем стандарте использованы следующие сокращения:
4 Основные положения
4.1 ЭД и РД разрабатывают как часть рабочей конструкторской документации по ГОСТ 2.601 и ГОСТ 2.602.
4.2 При выполнении ЭД (РД) в электронной форме ее представляют одним из двух способов:
а) в форме взаимосвязанной совокупности электронных ЭД (РД) по ГОСТ 2.051 или
4.3 В случае применения способа по 4.2 а) электронную ЭД (РД) представляют в общеупотребимых форматах (файлы PDF и т.п.), для работы с которыми используют стандартизованные программные средства (приложения) или аналогичные программы общего назначения в составе операционных систем вычислительных средств.
4.4 В случае применения способа по 4.2 б) для работы с ЭД (РД) используют специализированные программно-технические средства, поставляемые в составе ИЭТР.
4.5 Содержание и назначение ИЭТР определяются согласно требованиям к содержанию и назначению соответствующего вида ЭД или РД по ГОСТ 2.601 или ГОСТ 2.602. ИЭТР имеет такой же вид, как соответствующий ЭД (РД).
4.6 Одно ИЭТР может включать два или более видов ЭД (РД), необходимых для технической эксплуатации (ремонта) изделия в одной эксплуатирующей (ремонтной) организации. В этом случае вид ИЭТР устанавливается разработчиком.
4.7 Состав и содержание данных для включения в ЭД и РД (ИЭТР) сложных изделий обосновывают в рамках АЛП по ГОСТ Р 53392.