SCADA, АСУ ТП, контроллеры – основная тематика журнала «ИСУП»
Журнал «Информатизация и Системы Управления в Промышленности» публикует тематические материалы посвященные SCADA, АСУ ТП, контроллерам, автоматизации в промышленности.

Новые подходы к разработке эксплуатационной документации в электронном виде

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

ЗАО «Си Проект», г. Санкт-Петербург

Си-Проект.gif

Введение

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

Компания ЗАО «Си Проект» имеет богатый опыт разработки ИЭТР, а также занимается разработкой программных продуктов, реализующих информационную поддержку изделий на всех этапах жизненного цикла.


Нормативная база

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

Одним из самых распространенных зарубежных стандартов в этой части по праву считается S1000D. В нем вводится понятие модуля данных (МД) – блока информации, однозначно описывающего изделие и не подлежащего дальнейшему делению на блоки. Все модули данных хранятся в общей базе данных (CSDB). Каждый модуль специальным образом кодифицируется. Основные составные части кода указывают, что информация, содержащаяся в МД, относится к конкретному изделию (SNS) и действию (техническое обслуживание, устранение неисправностей и т. д.), проводимому над этим изделием (IC). При необходимости из общей базы – прямо из виртуальной сети – пользователь может получить интерактивную электронную техническую публикацию (ИЭТП). Такие публикации могут содержать разный набор модулей данных, в зависимости от области применения ИЭТП и типа информации, которую необходимо получить. Допустим, нам нужен только иллюстрированный каталог составных частей механизма, либо ИЭТП предназначена для персонала, проводящего только техническое обслуживание. Подобный набор данных в S1000D называется «информационным набором». Схема организации данных в соответствии со стандартом S1000D представлена на рис. 1.

Рис.1.png

Рис. 1. Схема организации данных в  соответствии со  стандартом S1000D

С понятием «интерактивная электронная техническая публикация» в S1000D можно сопоставить понятие «интерактивные электронные технические руководства» в отечественной нормативной базе. По отечественным стандартам все электронные технические руководства делятся на 4 класса. В соответствии с этой классификацией именно 3?й класс ИЭТР можно сопоставить с ИЭТП в S1000D.

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


Проблемы разработки ИЭТР

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

Относительно общего содержания технической публикации требования ГОСТ и S1000D примерно совпадают: согласно обоим нормативным документам в ней должна присутствовать информация о техническом обслуживании, типовых неисправностях, составе изделия и т. д. Однако встает вопрос: каким образом структурировать информацию в создаваемой публикации и как правильно определить перечень модулей данных? Также следует понять, как объединять информацию, если необходимо создать ИЭТП не только на само изделие, но и на его составные части.

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


Предлагаемые решения

Чтобы найти способы решения этой проблемы, возьмем машиностроительный механизм, документация на который выполнена по ГОСТ 2.601–2006, и попробуем реструктурировать приведенную в техническом руководстве информацию.

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

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

2. Требуется объединить по смыслу разделы основного руководства по эксплуатации изделия с разделами других эксплуатационных документов на это же изделие, выполненных по ГОСТ. 
При объединении разделов можно использовать разный подход.
- Включить в состав структуры разделов основного руководства по эксплуатации разделы из других документов. Допустим, в руководстве по эксплуатации выбранного нами механизма есть раздел «Демонтаж и монтаж». К данному разделу по смыслу близок документ «Монтажная инструкция». Объединить информацию можно, взяв структуру разделов «Монтажной инструкции» и включив их в качестве подразделов в раздел «Демонтаж и монтаж».
- Можно включать в состав структуры разделов основного руководства по эксплуатации целые документы. Например, в выбранном нами руководстве по эксплуатации есть раздел «Средства измерения, инструмент и принадлежности». Данному разделу соответствует по смыслу документ «Ведомость ЗИП1». Поскольку сам документ «Ведомость ЗИП» на разделы не разбит, его можно включить как модуль данных (1 МД) в состав раздела «Средства измерения, инструмент и принадлежности».
- Можно объединить сведения из разделов основного руководства по эксплуатации со сведениями из разделов других документов. Например, в руководстве по эксплуатации нашего изделия есть раздел «Технические характеристики». Этот раздел по смыслу соответствует разделу «Основные сведения об изделии и технические данные» из документа «Паспорт». В результате можно объединить информацию из двух документов в один раздел основного руководства по эксплуатации.
Способы объединения комплекта эксплуатационных документов, выполненных по ГОСТ, представлены на рис. 2.

Рис.2.png

Рис. 2. Объединение комплекта эксплуатационной документации в единый документ

3. Необходимо объединить разделы основного руководства по эксплуатации, посвященные составным частям изделия, с комплектом документов на эти же составные части. При отсутствии таких разделов требуется их создать. Допустим, в руководстве по эксплуатации изделия есть раздел «Описание и работа». В нем имеется два подраздела – «Описание и работа изделия» и «Описание и работа составных частей изделия». В разделе «Описание и работа изделия» дается информация об изделии в целом, а раздел «Описание и работа составных частей изделия» можно структурировать, разделив по наименованию составных частей, и в каждом таком подразделе привести сведения из основного руководства по эксплуатации об этой составной части. Аналогичный подход можно применить в разделе «Техническое обслуживание» из основного руководства по эксплуатации (рис. 3). В разделах, где информация о составных частях не предусмотрена, необходимо ее ввести. Например, разделы «Хранение», «Транспортирование», «Утилизация» основного руководства по эксплуатации не содержат информации о составных частях, поэтому необходимо ввести в каж­дом из этих разделов два подраздела: «Хранение изделия» и «Хранение составных частей изделия», «Транспортирование изделия» и «Транспортирование составных частей изделия», «Утилизация изделия» и «Утилизация составных частей изделия».
Способ объединения документов на составные части изделия в один документ проиллюстрирован на рис. 3.

Рис.3.png

Рис. 3. Объединение документов на составные части изделия в один документ


Плюсы использования решения

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

Статья опубликована в журнале «ИСУП», № 4(40)_2012

Е.П. Абросимов, руководитель отдела разработки ИЭТР, 
Д.А. Богданов, Генеральный директор,
ЗАО «Cи Проект», Санкт-Петербург,
тел.: (812) 740-3595,