Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Техническая документация: разбираемся в спецификациях S1000D и DITA

27.10.2014

27.10.14В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.


 

Спецификация S1000D

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

Преимущества спецификации S1000D:

  • Использование международных технологических стандартов, таких как SGML / XML и CGM
  • Гибкость, связанная с возможностями модуля данных
  • Открытый исходный код (непатентованный стандарт)

Внедрение спецификации S1000D

Спецификация S1000D исторически используется разработчиками оборудования, связанными с европейскими оборонными, сухопутными, морскими и воздушными военными проектами в Европе, США и Австралии. Совсем недавно использование спецификации распространилось на области гражданской аэрокосмической и железнодорожной промышленности.

Таким образом, две основные из недавних программ гражданской авиации используют S1000D: A350 (Airbus) и Dreamliner B787 (Boeing). Спецификация S1000D в основном используется в эксплуатационной документации для авиационных транспортных отраслей, но также железнодорожной и морской (при поддержке специфических протоколов RailDex и ShipDex, которые персонализируют соответствующие S1000D этих секторов).

Первоначально, в 1980-е годы, эта спецификация была создана Европейской ассоциацией производителей аэрокосмического оборудования (AECMA), чтобы удовлетворить потребности аэрокосмической и оборонной промышленности в технических публикациях. Спецификация с тех пор развивалась и с 2005 года устанавливает стандарты для документации любого транспортного средства или оборудования, будь то гражданское или военное.

Внедрение спецификации S1000D может быть простым или сложным в зависимости от сложности требований к проекту, реализующих эту спецификацию.

На самом деле официальной документации (книги, пресс-релизы, и т.д .) для обучения этой спецификации не существует, но информация доступна на веб-сайте http://www.s1000d.org .

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

Спецификация доступна на английском языке. Также есть переводы на французский и немецкий языки.

Архитектура DITA

Существует ещё один стандарт на основе XML, посвящённый разработке, проектированию и публикации технической информации. Это DITA (Дарвиновская Архитектура Типизированной Информации).

Главные особенности DITA:

  • Модульность контента
  • Повторное использование контента на основе рубрик (несколько уровней типизации рубрики)
  • Специализация (DITA можно расширить путём добавления новых элементов)
  • Создание и публикация контента (PDF через XSL-FO, XHTML, RTF и т.д.)

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

DITA создана для документации технических систем и остается вне конкуренции для программной или аппаратной документации в области ИТ, о чем свидетельствует её происхождение (IBM) и ее основные спонсоры (Microsoft, Intel, Cisco, Oracle, SAP). Возможность специализации (чего нет в S1000D) позволяет ей осваивать другие направления, как например, обучение. Так, компания Dassault System использует для документирования систему автоматизированного проектирования CATIA (Систему прикладного трёхмерного автоматизированного проектирования).

К минусам DITA относится сравнительная сложность, хотя многие издатели на рынке создали программное обеспечение для упрощения использования DITA. Этот стандарт весьма распространён в англо-саксонских странах.

Источник: Technical documentation: Understanding S1000D and DITA specifications

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов