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

Стандарт ASD S1000D. Эффективные методики разработки технической документации. Бумажное прошлое или электронное настоящее?

Проблема смешанной «бумажно-электронной» технической документации стоит не первый год, и скорого решения, к сожалению, не предвидится. И дело не только в технологических и юридических аспектах, но и в психологическом пороге восприятия. Сложные и непонятные большинству технологии электронной цифровой подписи (ЭЦП) подсознательно не вызывают доверия у пользователей. Особенно на фоне громких разоблачений преступлений в области цифровых технологий. На сегодняшний день одновременное существование «бумажной» и «электронной» технической документации воспринимается как объективная реальность. Параллельная разработка и актуализация и той, и другой вызывают множество вопросов как об эффективности затрачиваемых средств, так и о скорости вносимых изменений. Именно последний параметр в современной быстро изменяющейся экономической конъюнктуре зачастую является ключевым конкурентным преимуществом – тот, кто сможет быстрее предложить имеющий значение для потребителя товар или услугу, выиграет борьбу за рынок. Можно ли обратить недостатки параллельного существования «бумажной» и «электронной» технической документации в преимущество? Как быстро внести изменения в огромное количество документации? Как сократить издержки и поднять качество создаваемых вами документов? На эти и другие вопросы мы постараемся ответить в статье. Стандарт ASD S1000D.

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

SeaProject.png

Что же такое «бумажные» и «электронные» документы? Чем они различаются и чем схожи?

Если с электронным документом все достаточно просто, существует ГОСТ 2.051, который задает определение: «Электронный документ – это документ, выполненный как структурированный набор данных, создаваемых программно-техническим средством», – то с «бумажным» документом такой определенности нет.

Воспользуемся понятием «бумажный конструкторский документ» из ГОСТ 2.001 2013, которое определяется следующим образом: «Документ, выполненный на бумажном или аналогичном по назначению носителе (кальке, микрофильмах, микрофишах и т. п.). Бумажный конструкторский документ выполняют с целью использования или обработки (понимания) преимущественно человеком. Установленные подписи в бумажном конструкторском документе выполняют собственноручно». Если обратиться к ГОСТ Р ИСО / МЭК 15910-2002, под бумажным документом следует понимать «часть документации, представляемую в печатном виде», а согласно ГОСТ Р 52292-2004, это «форма представления документа в аналоговой среде». Но если дополнительно учесть тот факт, что в современных условиях практически все документы изначально создаются как электронные, то это еще больше запутывает ситуацию.

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

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

Для разработки бумажной документации, ориентированной на печатное представление, более всего применима давно известная и часто используемая разработчиками программного обеспечения технология «единого источника» (рис. 1).

Ris_1.png

Рис. 1. Технология «единого источника»

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

Чтобы нивелировать эти отрицательные факторы, и была сформулирована технология «единого источника». Суть ее состоит в создании отдельных модулей неформатированного текста и применении специальных правил для компиляции из них документов с целью получения единообразно представленной документации (рис. 2).

Ris_2.png

Рис. 2. Использование текстовых модулей из единого источника

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

Технология «единого источника» не представляет собой раз и навсегда сложившегося набора инструментов для работы, это скорее набор рекомендуемых практик, под которые, исходя из конкретных требований, подбирается инструментарий. Примером реализации технологии «единого источника» может считаться такая связка: редактор текста (Oxygen XML Editor, XMLMind, Syntext Serna), инструмент сборки документа из исходного формата (DITA, DocBook), единый источник хранения информации (системы контроля версий SVN, GIT, TFS или различные СУБД). Также возможны реализации на основе комплексных инструментов, объединяющих все три указанных компонента, например Author-It, Madcap Flare (рис. 3).

Ris_3.png

Рис. 3. Пример интерфейса Madcap Flare

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

Еще одним неоспоримым преимуществом является возможность создавать и применять к документам единые правила оформления. Эта функциональность помогает значительно сократить труд нормоконтролёра и разработчика документации. Единообразно оформленная документация позволяет сократить затраты на включение документации от контрагентов в общую документацию.

В случае если разрабатываемая документация ориентирована на представление в электронном и тем более в интерактивном виде, наиболее эффективным будет применение технологий стандарта ASD S1000D*. Стандарт ASD S1000D был рожден в авиационной промышленности, известной своими высокими требованиями к обеспечению безопасности. В настоящий момент S1000D успешно применяется в судостроении, атомной энергетике, тяжелой промышленности и космосе. Это отработанные и зрелые общемировые практики, основанные на лучшем опыте. Суть данного стандарта составляют несколько основных принципов:
- единая база данных для хранения информации;
- модульная система, когда информация хранится в виде модулей – минимальных самостоятельных единиц в технической публикации;
маленькие электронные документы составляются в большие (публикации, информационные наборы);
- идентификация объектов по уникальным кодам специальной структуры;
- повторное использование модулей, информация не дублируется;
- документация на конкретную конфигурацию изделия «собирается из кубиков».

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

Одним из инструментов реализации требований стандарта S1000D может являться редактор интерактивных электронных технических руководств Seamatica. В самой функционально наполненной редакции Seamatica Enterprise реализуется весь комплекс мероприятий разработки ИЭТР. Как единое хранилище информации Seamatica использует СУБД PostgreSQL, с помощью интерфейса редактора (рис. 4) данное хранилище модульно заполняется информацией, из которой публикуется ИЭТР.

Ris_4.png

Рис. 4. Интерфейс редактора ИЭТР Seamatica Enterprise

Логической основой для формирования структурированных данных является функционально сборочная структура (ФСС) – многоуровневая иерархическая структура элементов заказа, сгруппированных по их функциональному назначению (рис. 5).

Ris_5.png

Рис. 5. Функционально-сборочная структура

На функционально-сборочную структуру нанизываются различные модули данных (МД), которые могут быть описательными (текстовыми), параметрическими (ЗИП, ГСМ, процедуры ТО, планирование ТО и т. д.), процедурными (поиск и устранение неисправностей), а также различными видами иллюстраций (рис. 6).

Ris_6.png

Рис. 6. Создание и редактирование модулей данных

Содержимым описательного модуля данных чаще всего является фрагмент текста исходного документа, то есть документа, материалы которого включаются в ИЭТР (рис. 7).

Ris_7.png

Рис. 7. Редактор описательных модулей данных с текстом исходного документа

Разработанные в функционально-сборочной структуре описательные, параметрические и процедурные модули данных, а также импортированные иллюстрации, видеоролики, звуковые комментарии и 3D-модели собираются, структурируются и интегрируются с помощью взаимных гиперссылок на базе непосредственного документа ИЭТР 1–3 классов (рис. 8).

Ris_8.png

Рис. 8. Создание и редактирование документа ИЭТР 1–3 классов

Результатом публикации получившегося документа является ИЭТР в веб-представлении и готовый для просмотра в браузере (рис. 9).

Ris_9_small.png

Рис. 9. Опубликованный ИЭТР 3‑го класса отражает структуру, заданную в документе Seamatica Enterprise

Поразительно, что технологии, придуманные в разных отраслях промышленности, так сильно совпадают в общих концепциях и подходах. Если они так похожи, то почему бы это не использовать в благих целях? Что будет, если объединить технологию разработки «единого источника» для «бумажно»-ориентированного документа и S1000D для создания интерактивных электронных руководств?

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

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

Текстовые модули интерактивных электронных технических руководств должны формироваться на основе модулей текстовой информации «бумажных» документов (рис. 10).

Ris_10.png

Рис. 10. Схема интеграции технологии в процесс разработки ИЭТР по требованиям стандарта S1000D

Оба типа документов используют для создания, хранения и редактирования единую базу данных.

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

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

Приведенная методика – всего лишь один из инструментов, позволяющих добиться быстрой и качественной разработки электронной технической документации. Для решения всего комплекса проблем требуется организация дискуссионной площадки, которую мы попытаемся создать в следующем году. Следите за нашими анонсами на сайте www.seaproject.ru.
______________________________
* S1000D // ASD (Европейская ассоциация авиационно-космической и оборонной промышленности) : [сайт]. URL: www.asd-europe.org/s1000d (дата обращения: 20.12.2017).

Статья опубликована в журнале "ИСУП" № 6(72)_2017

Д. Г. Дикий, 
руководитель направления,
ЗАО «Си Проект», 
г. Санкт-Петербург,
тел: +7 (812) 740–3595,
e‑mail: info@seaproject.ru,
сайт: www.seaproject.ru



КОНТРОЛЛЕРЫ ВТР ДЛЯ СИСТЕМ ОТОПЛЕНИЯ
Для управления системами отопления, горячего водоснабжения, подпитки, повысительными насосами
www.vogez.by