Подготовка технических публикаций

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

Структура технической публикации создается в программном модуле «Редактор информационных наборов» системы TG Builder или в XML-файле публикации при разработке документации при помощи XML-редактора.

Кодирование технических публикаций

Каждой технической публикации должен быть присвоен стандартизованный код в соответствии с требованиями спецификации S1000D. Формат кода представлен на рисунке:



В качестве обозначения издающей организации необходимо использовать обозначение «SUDSB».

Номер публикации назначает разработчик документации (внутреннее обозначение публикации) используя следующие правила:
  • Первые три символа номера публикации указывают на тип публикации. Для документации предприятий-смежников возможны следующие два типа публикаций: CMP - Руководство по эксплуатации, AGE – Руководство по наземному оборудованию.
  • Последние два символа номера публикации содержат номер самолетной системы, к которой относится описываемое комплектующее изделие.

Номер тома применяется при необходимости разбить публикацию на тома (при подготовке бумажного комплекта). Если документация не разбита на тома, в качестве этого поля необходимо использовать «00».

Постфикс «-P» в коде публикации указывает на то, что под этим кодом выпускается бумажный комплект документации.

Пример кода публикации: AASMZ001A-SUDSB-CMP29-00-P

Служебные модули данных

Техническая публикация должна включать в себя следующие служебные модули данных:
  • Титульный лист (информационный код 001)
  • Перечень действующих страниц (информационный код 002)
  • Лист регистрации изменений (информационный код 003)
  • Перечень аббревиатур (информационный код 005)
  • Перечень терминов (информационный код 006)
  • Перечень условных обозначений (информационный код 007). При необходимости.
  • Оглавление (информационный код 009)