Формат xml s1000d что это такое
S1000D. Основные термины и сокращения
Спецификация S1000D описывает создание, структурирование и контроль технических публикаций, а также принципы публикаций в странично-ориентированном и электронном интерактивном форматах. В S1000D используется масса специализированных терминов, и в рамках этой статьи мы разберем основные из них.
Перечень необходимых модулей данных (DMRL — Data Module Requirement List) — документ со списком модулей, требующихся для проекта. Как инструмент для определения необходимых модулей, перечень может разрабатываться частями, например, партнерскими компаниями, или целиком. В российской системе стандартов аналогом Data Module Requirement List является план-проспект документации, определяющий начальный выбор разделов и их содержание.
Код модуля данных (DMC — Data Module Code) — буквенно-цифровая последовательность из 17-41 символов. Код определяет тип и применимость информации модуля данных, а также дает возможность вводить/извлекать модуль данных из БД.
Стандартная система нумерации (SNS — Standard Numbering System) — фрагмент кода модуля данных, используемый для определения составной части изделия. В российской системе стандартов похожий по смыслу термин («система нумерации и кодирования») используется в ГОСТ 2.601.
Информационный код (IC — Information code) — фрагмент кода модуля данных, определяющий тип информации, содержащейся в DM. Например, по стандарту S1000D модулю данных техобслуживания присваивается код 312.
Модуль данных (DM — Data Module) — самостоятельная информационная единица, которая идентифицируется кодом модуля данных. В DM содержатся данные, необходимые для идентификации и описания изделия, его компонентов, процессов технического обслуживания и эксплуатации, в том числе и вспомогательного оборудования. В составе модуля 2 части:
Модуль данных разрабатывается в форме, которая позволяет вводить и извлекать его из базы данных, пользуясь в качестве идентификатора кодом DM.
Контрольный номер информации (ICN — Information Control Number) — буквенно-цифровая последовательность, присваиваемая графическим и мультимедийным объектам, а также прочим данным с адресом информационного объекта в общей базе исходных данных (CSDB). ICN позволяет связывать иллюстративный материал, мультимедиа и другие данные с одним или несколькими DM. Спецификация S1000D включает в состав номера 10 элементов. По сути, структура кода ICN во многом сходна с DMC.
Активная точка (hotspot) — иллюстративная зона, предварительно определенная в файле CGM или в содержательной части DM в виде карты активных точек. Эта зона обеспечивает интерактивную связь элементов иллюстрации с содержанием модуля, а также другими информационными объектами в базе исходных данных.
В компании «Иторум» вы можете заказать разработку интерактивной электронной технической документации в соответствии со спецификацией S1000D — релевантный опыт в сочетании с высокой квалификацией инициативной команды специалистов обеспечит быстрый, точный и качественный результат. Оставьте заявку в форме обратной связи или позвоните по тел. 8495-120-80-55, мы будем рады проконсультировать и оказать помощь по всем вопросам технических публикаций.
Иллюстрированный каталог деталей и сборочных единиц по стандарту S1000D
Мария Корьевкина, 2012
Введение
Эта статья написана главным образом для инженеров, технических писателей и других специалистов, которые впервые приступают к работе со спецификацией S1000D и должны разобраться в том, что представляет собой данная спецификация и какое место занимает в ней иллюстрированный каталог деталей и сборочных единиц. В конце статьи рассматриваются простейшие способы создания иллюстрированного каталога, удовлетворяющего спецификации S1000D.
Происхождение и роль спецификации S1000D
Если говорить совсем кратко, то спецификация S1000D — это международный стандарт на техническую документацию в аэрокосмической отрасли. Она не является стандартом ISO, однако во многих странах, особенно технологически развитых, используется как стандарт де-факто, причем не только в аэрокосмической отрасли, но и в других областях, где требуется собирать, систематизировать и публиковать большие объемы технической информации, — например, в судостроении и автомобилестроении.
В настоящее время над спецификацией работают три организации, каждая из которых представляет собой крупное отраслевое объединение:
Некоторые ключевые понятия S1000D
Технические публикации. Одним из наиболее важных понятий спецификации S1000D является техническая публикация. Под технической публикацией понимается документ или ресурс, который мы можем в той или иной форме предоставить читателю. Например, документ Руководство по летной эксплуатации — это техническая публикация.
Иллюстрированный каталог деталей и сборочных единиц также считается технической публикацией, независимо от того, напечатан ли он на бумаге как брошюра (книга) или представляет собой гипертекст, существующий только в электронном виде.
Допуская различные типы технических публикаций, спецификация предъявляет довольно строгие единые детализированные требования к их структуре и оформлению. Жесткость требований может удивить отечественного специалиста по технической документации, привыкшего к тому, что западные стандарты обычно бывают более расплывчатыми и либеральными, чем российские.
Модули данных. Согласно спецификации S1000D, техническая публикация состоит из блоков информации, называемых модулями данных. Модуль данных может содержать сведения об устройстве, эксплуатации, техническом обслуживании изделия, о поиске и устранении неисправностей, перечни изделий /деталей с иллюстрациями, схемы электрооборудования, информацию о ссылках внутри технической публикации и т. п.
В зависимости от своего содержания модули данных подразделяются по типам — например, модуль иллюстрированного каталога и модуль схемы электрооборудования относятся к разным типам. Для модулей каждого типа определен состав данных, которые могут или должны там присутствовать, причем указывается, какие данные являются обязательными, а какие факультативными. Для модуля иллюстрированного каталога информация о деталях в структурированном виде — это обязательные данные, а графические изображения деталей и информацию о зонах, в которых расположены детали, — факультативные данные.
Структура публикации. С формальной точки зрения техническая публикация представляет собой модуль данных специального типа — модуль публикации, — представляющий собой набор ссылок на модули данных, которые должны войти в публикацию. Таким способом определяются используемые типы модулей данных, порядок следования модулей и требования к их содержанию.
Представление данных. Спецификация S1000D предполагает, что все модули, относящиеся к определенному проекту (изделию, серии изделий), находятся в единой базе данных. Это позволяет централизованно хранить техническую информацию и управлять ее подготовкой. Спецификация не предъявляет конкретных требований к структуре базы данных или к тому, какая СУБД должна использоваться для работы с ней. Однако она содержит XML-схемы для каждого типа модулей данных, а также XML-схему модуля технической публикации.
Иллюстрированный каталог деталей и сборочных единиц по спецификации S1000D
В версии 4.0 спецификации S1000D иллюстрированные каталоги деталей и сборочных единиц регламентированы разделом 5.3.1.3 (возможно, в следующих версиях это изменится).
Основные функции, которые выполняет иллюстрированный каталог деталей и сборочных единиц, согласно спецификации таковы:
Спецификацией определены следующие свойства иллюстрированного каталога деталей и сборочных единиц:
Разграничение между печатной и электронной версиями носит условный характер. Очевидно, документ для печати может быть представлен в виде файла формата PDF и прочитан с экрана, а страница гипертекста — распечатана. На рис. 1 показана структура иллюстрированного каталога деталей и сборочных единиц.
Рисунок 1. Структура иллюстрированного каталога деталей и сборочных единиц.
На рис. 2 показана структура XML-файлов иллюстрированного каталога деталей и сборочных единиц.
Рисунок 2. Структура XML-файлов иллюстрированного каталога деталей и сборочных единиц
На рис. 3 показана структура модуля данных иллюстрированного каталога деталей и сборочных единиц.
Рисунок 3. Структура модуля данных иллюстрированного каталога деталей и сборочных единиц (XML). Источник: спецификация S1000D версия 4.0.
На рис. 4 показана XML-разметка модуля иллюстрированного каталога деталей и сборочных единиц.
Рисунок 4. Пример XML-разметки модуля данных иллюстрированного каталога деталей и сборочных единиц. Источник: спецификация S1000D (с сокращениями; часть строк примера скрыта с помощью функции свертывания XML-редактора)
На рис. 5 представлен пример интерактивной электронной публикации иллюстрированного каталога деталей и сборочных единиц.
Рисунок 5. Интерактивный электронный иллюстрированный каталог деталей и сборочных единиц, подготовленный в приложении TGBuilder (пример представлен с помощью программы TGBrowser)
Иллюстрации
Иллюстрации в каталоге должны позволять идентифицировать не только деталь (сборочную единицу), но и ее место в изделии. Поэтому подготовка качественных иллюстраций занимает значительную часть времени при создании каталогов. Как правило, иллюстрации должны выполняться в виде векторных или растровых чертежей, но стандартом также допускается использование фотографий и трехмерных моделей. Файлы иллюстраций хранятся отдельно (см. рис. 2). Рекомендуемые форматы графических файлов — CGM, TIFF, CG4, PNG, JPG, GIF. На иллюстрации номера деталей и сборочных единиц должны быть обозначены выносками. В электронном каталоге используются интерактивные иллюстрации, т. е. при нажатии на выноску с номером детали автоматически выбирается соответствующая позиция в каталоге (см. рис. 5).
Подготовка иллюстрированного каталога
Подготовкой каталогов на заказ занимаются некоторые специализированные организации. Стоимость их услуг зависит от количества модулей в каталоге и от того, требуется ли подготовить иллюстрации. Подготовка иллюстраций, особенно трехмерных, может составлять существенную часть затрат.
Перейдем теперь к ситуации, когда аутсорсинг невозможен или нежелателен. Реальные потребности организаций могут быть самыми разными; допустим, нам необходимо подготовить две технических публикации:
Для создания каталога нам потребуются два набора данных:
Самый простой технологически, хотя и довольно трудоемкий, способ изготовления иллюстрированного каталога — ручной, с использованием для создания документов универсальных текстовых или XML-редакторов. Здесь вам придется самостоятельно обеспечивать соответствие результата требованиям спецификации. Этот вариант может оказаться оптимальным, если предполагается выполнять лишь небольшие эпизодические работы, поскольку специализированный инструментарий, необходимый при значительных объемах публикаций, недешев и требует освоения.
К числу специализированных инструментов для подготовки публикаций по стандарту S1000D относятся:
Отечественные стандарты на иллюстрированные каталоги
В России в соответствии с ГОСТ 2.601 «Эксплуатационные документы» каталог деталей и сборочных единиц считается одним из видов эксплуатационных документов. Стандарт определяет общие требования к тексту, оформлению иллюстраций и другим параметрам эксплуатационных документов. С 01.01.2012 действует ГОСТ 2.611-2011 «Электронный каталог изделий. Общие положения». Этот стандарт регламентирует требования к электронным каталогам и их разработке. Последние версии обоих стандартов разработаны на основе спецификации S1000D, но учитывают не все ее положения. Таким образом, каталог, полностью удовлетворяющий требованиям спецификации S1000D, будет соответствовать ГОСТ 2.611-2011, хотя обратное неверно.
Стандарт ASD S1000D. Эффективные методики разработки технической документации. Бумажное прошлое или электронное настоящее?
Проблема смешанной «бумажно-электронной» технической документации стоит не первый год, и скорого решения, к сожалению, не предвидится. И дело не только в технологических и юридических аспектах, но и в психологическом пороге восприятия. Сложные и непонятные большинству технологии электронной цифровой подписи (ЭЦП) подсознательно не вызывают доверия у пользователей. Особенно на фоне громких разоблачений преступлений в области цифровых технологий. На сегодняшний день одновременное существование «бумажной» и «электронной» технической документации воспринимается как объективная реальность. Параллельная разработка и актуализация и той, и другой вызывают множество вопросов как об эффективности затрачиваемых средств, так и о скорости вносимых изменений. Именно последний параметр в современной быстро изменяющейся экономической конъюнктуре зачастую является ключевым конкурентным преимуществом – тот, кто сможет быстрее предложить имеющий значение для потребителя товар или услугу, выиграет борьбу за рынок. Можно ли обратить недостатки параллельного существования «бумажной» и «электронной» технической документации в преимущество? Как быстро внести изменения в огромное количество документации? Как сократить издержки и поднять качество создаваемых вами документов? На эти и другие вопросы мы постараемся ответить в статье. Стандарт ASD S1000D.
ЗАО «Си Проект», г. Санкт-Петербург
Что же такое «бумажные» и «электронные» документы? Чем они различаются и чем схожи?
Если с электронным документом все достаточно просто, существует ГОСТ 2.051, который задает определение: «Электронный документ – это документ, выполненный как структурированный набор данных, создаваемых программно-техническим средством», – то с «бумажным» документом такой определенности нет.
Воспользуемся понятием «бумажный конструкторский документ» из ГОСТ 2.001 2013, которое определяется следующим образом: «Документ, выполненный на бумажном или аналогичном по назначению носителе (кальке, микрофильмах, микрофишах и т. п.). Бумажный конструкторский документ выполняют с целью использования или обработки (понимания) преимущественно человеком. Установленные подписи в бумажном конструкторском документе выполняют собственноручно». Если обратиться к ГОСТ Р ИСО / МЭК 15910-2002, под бумажным документом следует понимать «часть документации, представляемую в печатном виде», а согласно ГОСТ Р 52292-2004, это «форма представления документа в аналоговой среде». Но если дополнительно учесть тот факт, что в современных условиях практически все документы изначально создаются как электронные, то это еще больше запутывает ситуацию.
Сложилось общепринятое мнение, что к бумажному или к электронному типу документ относит его представление. В печатном представлении – бумажный документ, на цифровом носителе информации – электронный документ.
Предварительно сформулированные требования к представлению документа конечному пользователю определяют тип документа – бумажный или электронный. Именно это отличие накладывает требования на методику разработки документа.
Для разработки бумажной документации, ориентированной на печатное представление, более всего применима давно известная и часто используемая разработчиками программного обеспечения технология «единого источника» (рис. 1).
Рис. 1. Технология «единого источника»
Часто меняющиеся требования, которые невозможно сформулировать заранее при формировании ТЗ, вынуждают разработчиков программного обеспечения многократно изменять спецификации, формуляры, описание программы и различные руководства. Многочисленные изменения увеличивают затраты, сроки поставки программного обеспечения заказчику, накладывают опечаток на качество получаемой программной документации.
Чтобы нивелировать эти отрицательные факторы, и была сформулирована технология «единого источника». Суть ее состоит в создании отдельных модулей неформатированного текста и применении специальных правил для компиляции из них документов с целью получения единообразно представленной документации (рис. 2).
Рис. 2. Использование текстовых модулей из единого источника
Для быстрого внесения изменений достаточно откорректировать текст в модуле или иллюстрацию, автоматически настроенные правила соберут весь пакет измененной документации в определенном согласно ГОСТ виде.
Технология «единого источника» не представляет собой раз и навсегда сложившегося набора инструментов для работы, это скорее набор рекомендуемых практик, под которые, исходя из конкретных требований, подбирается инструментарий. Примером реализации технологии «единого источника» может считаться такая связка: редактор текста (Oxygen XML Editor, XMLMind, Syntext Serna), инструмент сборки документа из исходного формата (DITA, DocBook), единый источник хранения информации (системы контроля версий SVN, GIT, TFS или различные СУБД). Также возможны реализации на основе комплексных инструментов, объединяющих все три указанных компонента, например Author-It, Madcap Flare (рис. 3).
Рис. 3. Пример интерфейса Madcap Flare
Интересным способом применения данной технологии является сквозная разработка программной или конструкторской документации. Такой подход позволяет, отталкиваясь непосредственно от требований ГОСТ, формировать ТЗ, программу и методику испытаний, описание программы, руководство оператора или системного администратора. Во всей этой линейке документов будут использоваться модули текста, начиная с пунктов требований ГОСТ, что позволяет не только сократить затраты на изменения, но и сделать процесс разработки документации более прозрачным, непротиворечивым и однозначно понимаемым. То есть мы всегда сможем сказать, откуда появился, например, конкретный пункт руководства оператора, какому пункту ТЗ он соответствует и с каким требованием ГОСТ соотносится.
Еще одним неоспоримым преимуществом является возможность создавать и применять к документам единые правила оформления. Эта функциональность помогает значительно сократить труд нормоконтролёра и разработчика документации. Единообразно оформленная документация позволяет сократить затраты на включение документации от контрагентов в общую документацию.
В случае если разрабатываемая документация ориентирована на представление в электронном и тем более в интерактивном виде, наиболее эффективным будет применение технологий стандарта ASD S1000D*. Стандарт ASD S1000D был рожден в авиационной промышленности, известной своими высокими требованиями к обеспечению безопасности. В настоящий момент S1000D успешно применяется в судостроении, атомной энергетике, тяжелой промышленности и космосе. Это отработанные и зрелые общемировые практики, основанные на лучшем опыте. Суть данного стандарта составляют несколько основных принципов:
— единая база данных для хранения информации;
— модульная система, когда информация хранится в виде модулей – минимальных самостоятельных единиц в технической публикации;
маленькие электронные документы составляются в большие (публикации, информационные наборы);
— идентификация объектов по уникальным кодам специальной структуры;
— повторное использование модулей, информация не дублируется;
— документация на конкретную конфигурацию изделия «собирается из кубиков».
Методология стандарта S1000D заключается в формировании отдельных модулей данных, которые могут содержать как текстовые, так и параметрические (технические характеристики, ЗИП, ГСМ, планирование ТО) или процессные (поиск и устранение неисправности, контроль знаний обслуживающего персонала) данные. Отдельно формируются различные иллюстративные материалы, аудиокомментарии и справочные данные. Все эти элементы собираются на основе структурированного документа и могут быть выгружены из базы данных путем процесса публикации для просмотра в виде интерактивного электронного технического руководства (ИЭТР) через стандартный браузер, установленный у конечного пользователя. Модульность, непротиворечивость, повторное использование информации дают значительный прирост в скорости прохождения изменений информации в электронном документе. Интерактивное представление улучшает восприятие и удобство пользователя.
Одним из инструментов реализации требований стандарта S1000D может являться редактор интерактивных электронных технических руководств Seamatica. В самой функционально наполненной редакции Seamatica Enterprise реализуется весь комплекс мероприятий разработки ИЭТР. Как единое хранилище информации Seamatica использует СУБД PostgreSQL, с помощью интерфейса редактора (рис. 4) данное хранилище модульно заполняется информацией, из которой публикуется ИЭТР.
Рис. 4. Интерфейс редактора ИЭТР Seamatica Enterprise
Логической основой для формирования структурированных данных является функционально сборочная структура (ФСС) – многоуровневая иерархическая структура элементов заказа, сгруппированных по их функциональному назначению (рис. 5).
Рис. 5. Функционально-сборочная структура
На функционально-сборочную структуру нанизываются различные модули данных (МД), которые могут быть описательными (текстовыми), параметрическими (ЗИП, ГСМ, процедуры ТО, планирование ТО и т. д.), процедурными (поиск и устранение неисправностей), а также различными видами иллюстраций (рис. 6).
Рис. 6. Создание и редактирование модулей данных
Содержимым описательного модуля данных чаще всего является фрагмент текста исходного документа, то есть документа, материалы которого включаются в ИЭТР (рис. 7).
Рис. 7. Редактор описательных модулей данных с текстом исходного документа
Разработанные в функционально-сборочной структуре описательные, параметрические и процедурные модули данных, а также импортированные иллюстрации, видеоролики, звуковые комментарии и 3D-модели собираются, структурируются и интегрируются с помощью взаимных гиперссылок на базе непосредственного документа ИЭТР 1–3 классов (рис. 8).
Рис. 8. Создание и редактирование документа ИЭТР 1–3 классов
Результатом публикации получившегося документа является ИЭТР в веб-представлении и готовый для просмотра в браузере (рис. 9).
Рис. 9. Опубликованный ИЭТР 3‑го класса отражает структуру, заданную в документе Seamatica Enterprise
Поразительно, что технологии, придуманные в разных отраслях промышленности, так сильно совпадают в общих концепциях и подходах. Если они так похожи, то почему бы это не использовать в благих целях? Что будет, если объединить технологию разработки «единого источника» для «бумажно»-ориентированного документа и S1000D для создания интерактивных электронных руководств?
Не секрет, что большинство интерактивной электронной документации разрабатывается на основе документов «бумажной» направленности. Эта предпосылка дает нам возможность на основе двух разных технологий, «единого источника» и S1000D, выстроить единый и прозрачный процесс разработки технической документации.
Начало процесса должно быть положено с внесения ГОСТ, касающихся разработки электронной документации (2.051, 2.601, 2.602, 5488) в виде отдельных текстовых моделей разработки и сборки основных «бумажных» документов по технологии единого источника с формированием связей от пунктов требований ГОСТ до руководства пользователя.
Текстовые модули интерактивных электронных технических руководств должны формироваться на основе модулей текстовой информации «бумажных» документов (рис. 10).
Рис. 10. Схема интеграции технологии в процесс разработки ИЭТР по требованиям стандарта S1000D
Оба типа документов используют для создания, хранения и редактирования единую базу данных.
Приведенная методика может значительно сократить время разработки технической документации, убрать разрыв между «бумажной» и интерактивной электронной документацией, увеличить скорость прохождения изменений по цепочке «технический писатель – разработчик интерактивной электронной документации – конечный пользователь», сократить затраты на нормоконтроль, повысить прозрачность документации, существенно поднять ее качество, облегчить взаимодействие с контрагентами.
Высокая скорость изменений и качество – современные конкурентные преимущество для любой компании. Обеспечить эти преимущества без быстрого внесения изменений в техническую документацию невозможно.
Приведенная методика – всего лишь один из инструментов, позволяющих добиться быстрой и качественной разработки электронной технической документации. Для решения всего комплекса проблем требуется организация дискуссионной площадки, которую мы попытаемся создать в следующем году. Следите за нашими анонсами на сайте www.seaproject.ru.
______________________________
* S1000D // ASD (Европейская ассоциация авиационно-космической и оборонной промышленности) : [сайт]. URL: www.asd-europe.org/s1000d (дата обращения: 20.12.2017).
Статья опубликована в журнале «ИСУП» № 6(72)_2017