Мария Корьевкина, 2012
Эта статья написана главным образом для инженеров, технических писателей и других специалистов, которые впервые приступают к работе со спецификацией S1000D и должны разобраться в том, что представляет собой данная спецификация и какое место занимает в ней иллюстрированный каталог деталей и сборочных единиц. В конце статьи рассматриваются простейшие способы создания иллюстрированного каталога, удовлетворяющего спецификации S1000D.
Если говорить совсем кратко, то спецификация S1000D — это международный стандарт на техническую документацию в аэрокосмической отрасли. Она не является стандартом ISO, однако во многих странах, особенно технологически развитых, используется как стандарт де-факто, причем не только в аэрокосмической отрасли, но и в других областях, где требуется собирать, систематизировать и публиковать большие объемы технической информации, — например, в судостроении и автомобилестроении.
В настоящее время над спецификацией работают три организации, каждая из которых представляет собой крупное отраслевое объединение:
Технические публикации. Одним из наиболее важных понятий спецификации S1000D является техническая публикация. Под технической публикацией понимается документ или ресурс, который мы можем в той или иной форме предоставить читателю. Например, документ Руководство по летной эксплуатации — это техническая публикация.
Иллюстрированный каталог деталей и сборочных единиц также считается технической публикацией, независимо от того, напечатан ли он на бумаге как брошюра (книга) или представляет собой гипертекст, существующий только в электронном виде.
Допуская различные типы технических публикаций, спецификация предъявляет довольно строгие единые детализированные требования к их структуре и оформлению. Жесткость требований может удивить отечественного специалиста по технической документации, привыкшего к тому, что западные стандарты обычно бывают более расплывчатыми и либеральными, чем российские.
Модули данных. Согласно спецификации S1000D, техническая публикация состоит из блоков информации, называемых модулями данных. Модуль данных может содержать сведения об устройстве, эксплуатации, техническом обслуживании изделия, о поиске и устранении неисправностей, перечни изделий /деталей с иллюстрациями, схемы электрооборудования, информацию о ссылках внутри технической публикации и т. п.
В зависимости от своего содержания модули данных подразделяются по типам — например, модуль иллюстрированного каталога и модуль схемы электрооборудования относятся к разным типам. Для модулей каждого типа определен состав данных, которые могут или должны там присутствовать, причем указывается, какие данные являются обязательными, а какие факультативными. Для модуля иллюстрированного каталога информация о деталях в структурированном виде — это обязательные данные, а графические изображения деталей и информацию о зонах, в которых расположены детали, — факультативные данные.
Структура публикации. С формальной точки зрения техническая публикация представляет собой модуль данных специального типа — модуль публикации, — представляющий собой набор ссылок на модули данных, которые должны войти в публикацию. Таким способом определяются используемые типы модулей данных, порядок следования модулей и требования к их содержанию.
Представление данных. Спецификация S1000D предполагает, что все модули, относящиеся к определенному проекту (изделию, серии изделий), находятся в единой базе данных. Это позволяет централизованно хранить техническую информацию и управлять ее подготовкой. Спецификация не предъявляет конкретных требований к структуре базы данных или к тому, какая СУБД должна использоваться для работы с ней. Однако она содержит XML-схемы для каждого типа модулей данных, а также XML-схему модуля технической публикации.
В версии 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, хотя обратное неверно.