Xml s1000d формат файла
ASD S1000D (ранее AECMA S1000D) — спецификация на выпуск технических публикаций с использованием базы данных общего доступа. Регламентирует форматы PDF и ИЭТР. Изначально, этот стандарт использовался в авиастроении, теперь этот стандарт расширен и применяется для многих отраслей, в том числе в кораблестроении. Стандарт S1000D — является обязательным к использованию в странах НАТО, Европы и Северной Америки. Технически, S1000D основан на технологии XML. Схемы подробно описаны и доступны бесплатно.
Ссылки
Wikimedia Foundation . 2010 .
Полезное
Смотреть что такое "S1000D" в других словарях:
S1000D — is an international specification for the procurement and production of technical publications. It is an SGML/XML standard for preparing, managing, and using equipment maintenance and operations information. It was initially developed by the… … Wikipedia
S1000D — Die Spezifikation S1000D International specification for technical publications utilizing a common source database ist weltweit ein wesentliches Dokument für Technische Dokumentation in den Bereichen Luftfahrt und Wehrmaterial. Herausgeber sind… … Deutsch Wikipedia
Common Source Data Base — Technical documentation is used in many areas of the everyday life. Nearly everything has to be provided with at minimum a drawing including a few locators. The product liability and many other issues regarding consumer protection have to be… … Wikipedia
AECMA — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
Aerospace and Defence Industries Association of Europe — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
Association Europeenne des Constructeurs de Materiel Aerospatial — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
Association Européenne des Constructeurs de Matériel Aérospatial — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
European Association of Aerospace Industries — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
The European Association of Aerospace Industries — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
AeroSpace and Defence Industries Association of Europe — Die Association Européenne des Constructeurs de Matériel Aérospatial (AECMA) später The European Association of AeroSpace Industries ist eine Interessenorganisation der europäischen Luftfahrtindustrie gewesen, deren Wurzeln auf der 1950… … Deutsch Wikipedia
Спецификация 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 части:
- Идентификационно-статусная (IDSTATUS), включающая код МД, версию, секретность, применимость, контроль качества.
- Содержательная (CONTENT), специфичная для каждого модуля данных (электросхемы, регламент, ПиУн и пр.).
Модуль данных разрабатывается в форме, которая позволяет вводить и извлекать его из базы данных, пользуясь в качестве идентификатора кодом DM.
Контрольный номер информации (ICN — Information Control Number) — буквенно-цифровая последовательность, присваиваемая графическим и мультимедийным объектам, а также прочим данным с адресом информационного объекта в общей базе исходных данных (CSDB). ICN позволяет связывать иллюстративный материал, мультимедиа и другие данные с одним или несколькими DM. Спецификация S1000D включает в состав номера 10 элементов. По сути, структура кода ICN во многом сходна с DMC.
Активная точка (hotspot) — иллюстративная зона, предварительно определенная в файле CGM или в содержательной части DM в виде карты активных точек. Эта зона обеспечивает интерактивную связь элементов иллюстрации с содержанием модуля, а также другими информационными объектами в базе исходных данных.
В компании «Иторум» вы можете заказать разработку интерактивной электронной технической документации в соответствии со спецификацией S1000D — релевантный опыт в сочетании с высокой квалификацией инициативной команды специалистов обеспечит быстрый, точный и качественный результат. Оставьте заявку в форме обратной связи или позвоните по тел. 8495-120-80-55, мы будем рады проконсультировать и оказать помощь по всем вопросам технических публикаций.
27.10.2014
В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.
Спецификация S1000D
S1000D – это спецификация для производства технической документации, связанной с эксплуатацией (ТОиР – Техническое обслуживание и ремонт), основанная на концепции модулей данных и хранящаяся в общей базе данных эксплуатационной документации (ОБДЭ). Эта спецификация полностью отвечает требованиям технического обслуживания для всех видов воздушных, наземных и водных механизмов, которые содержат большое число компонентов. Таким образом, спецификация S1000D позволяет организовывать информацию в модульной форме, повторно использовать модули данных, избегать дублирования информации, что подразумевает значительную экономию денежных и временных затрат при создании и управлении публикациями.
Преимущества спецификации S1000D:
- Использование международных технологических стандартов, таких как SGML / XML и CGM
- Гибкость, связанная с возможностями модуля данных
- Открытый исходный код (непатентованный стандарт)
Внедрение спецификации S1000D
Спецификация S1000D исторически используется разработчиками оборудования, связанными с европейскими оборонными, сухопутными, морскими и воздушными военными проектами в Европе, США и Австралии. Совсем недавно использование спецификации распространилось на области гражданской аэрокосмической и железнодорожной промышленности.
Таким образом, две основные из недавних программ гражданской авиации используют S1000D: A350 (Airbus) и Dreamliner B787 (Boeing). Спецификация S1000D в основном используется в эксплуатационной документации для авиационных транспортных отраслей, но также железнодорожной и морской (при поддержке специфических протоколов RailDex и ShipDex, которые персонализируют соответствующие S1000D этих секторов).
Первоначально, в 1980-е годы, эта спецификация была создана Европейской ассоциацией производителей аэрокосмического оборудования (AECMA), чтобы удовлетворить потребности аэрокосмической и оборонной промышленности в технических публикациях. Спецификация с тех пор развивалась и с 2005 года устанавливает стандарты для документации любого транспортного средства или оборудования, будь то гражданское или военное.
Внедрение спецификации S1000D может быть простым или сложным в зависимости от сложности требований к проекту, реализующих эту спецификацию.
Сегодня можно найти очень небольшое количество литературы по обучению, это в первую очередь связано с тем, что спецификация 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. Этот стандарт весьма распространён в англо-саксонских странах.
S1000D is an international specification for the production of technical publications. Although the title emphasizes its use for technical publications, application of the specification to non-technical publications is also possible and can be very beneficial to businesses requiring processes and controls.
This specification was initially developed by the AeroSpace and Defence Industries Association of Europe (ASD). Currently, S1000D is jointly produced by the following organizations, their members, and customers:
These organizations form the S1000D Council and the S1000D Steering Committee. These groups are dedicated to establishing mutually agreed standards for the documentation methods used by the participating parties.
With Issue 2, the scope of S1000D was extended to include land and sea specific applications. The specification continues to evolve and now supports:
History
The concept of this specification was originated in the early 1980s as an aerospace standard within the Aerospace and Defence Industries of Europe (ASD) formerly known as AECMA. At that time, most civil airline projects were being documented in accordance with specification ATA 100 with military projects following various national specifications.
With the development of Integrated Logistics Support (ILS) and information technology the AECMA Customer and Product Support Committee (CPSC) established a Documentation Working Group (DWG).
This group consisted of European industry representatives tasked to report on current documentation practices and to recommend a unified method of documentation for air vehicle projects. The DWG recognized that the only internationally accepted specification in the aerospace field was ATA 100.
It was therefore decided to attempt to harmonize civil and military documentation using ATA 100 as a source document. The DWG invited the nations to provide military representatives who would participate in its activities and established a subsidiary, which was designated the Augmented Documentation Working Group (ADWG).
The ADWG was superseded by the Technical Publications Specification Maintenance Group (TPSMG), which in turn was superseded recently by the S1000D Steering Committee (SC) which now has the full responsibility of maintaining the specification. The SC includes members from military and industry from various countries.
Structure
To ease reading of the specification it has been split into multiple chapters covering aspects such as creation, management and publishing, the full lifecycle of technical publications creation.
Principal Concepts
The following sections deal with the principal concepts within the specification. These concepts underpin a publications program using S1000D, and enable a move from a book paradigm to an information one.
Data Module
A data module is defined as a stand alone information unit and contains descriptive, procedural or operational data for a platform, system or a component.
It is produced in such a form that it can be stored and retrieved from a Common Source Data Base by using the data module code as the identifier.
It is produced in SGML (up to S1000D Issue 3.0) or XML according to specific DTDs or Schemas, all of which are provided with the specification (Note: Click Here to download S1000D DTDs and Schemas).
Data Module Structure
Each data module comprises two parts, identification and status section and a contents section.
The Identification and Status section provides information for:
- Managing the data module within the CSDB.
- Managing data module applicability.
- Managing the quality assurance process.
- Controlling the retrieval processes.
The contents section provides the user with the actual information required to conduct the task or describe the system. S1000D has defined various information types, e.g.:
- Crew
- Description
- Procedural
- Fault
- Illustrated Parts Data
- Schedules
- Wiring
- Process Module
- Business Rules Exchange
- Common Source Data Base (CSDB)
Common Source Data Base (CSDB)
This is the “store” for the containment and management of data modules, S1000D however does not define its functionality or otherwise. It just states that there is a requirement to hold and manage the data modules produced within a program(s).
This is a guide for technical writers and illustrators. The world of technical writing is changing from the linear writing concept of a beginning, middle and end. It is moving toward a concept of having the precise information you need exactly when you need it in the form that suits you best given the situation you are in right now.
The group leading the charge in this mission is the international standards organization S1000D.
The purpose of this book is to provide a guide for technical writers and illustrators who want to deliver documentation in compliance with S1000D technical publication standards.
Most technical writers use MicroSoft Word or a similar application to create technical documentation. However, technical documentation is moving into cloud databases where there is more than meets your eye.
Most standard applications we have been using for years are not up to the requirements of the digital age. Microsoft Word and other applications simply cannot get the job done.
What is required now is digestible meta data. Searchable connected information and the international standards organization S1000D has defined those data standards.
It is “open source” which means anyone can use those standards. It does not require a specific software application, so, in theory simply producing text in notepad will do, as long as you adhere to the rules of S1000D. And the primary rule is that the data must be in .xml format.
XML is a programming code that has been around since the 1960’s. XML stands for eXtensible Markup Language. The programming code was designed to store and transport data. XML was designed from the beginning to be both human and machine-readable.
Look at it this way, XML is a set of rules for encoding documents electronically through the use of markup. Its primary purpose is to facilitate the sharing data across different information systems. It is a product of the World Wide Web Consortium (W3C).
XML provides a foundation that anyone can use to build a document. It is not proprietary nor “owned” by anyone. It does have a consortium of international members who keep it an open, usable system for everyone. XML is used globally. It was one of the first tools used for building websites, which became HTML (Hypertext Markup Language).
S1000D defines the standardization of XML specifically for technical documentation. And one of the characteristics of the S1000D is that it also uses an “open systems” approach to the production of technical publications. The specification does not require a specific tool or application.
XML is used by a variety of industries. Some interesting ones are Golfing: GolfML, Aerospace:Spacecraft Markup Language, Music: Music Markup Language, Advertising: AdXML, Artificial Intelligence: AIML and fiction eBooks: FictionBook.
What made XML so popular is that it can be exported to iPads, iPhones, internet web browsers, laptops, for any industry and it is adaptable.
Using music as an example, Music.XML is supported by scorewriting programs including Finale, Sibelius and MuseScore. The Music.XML has optical character recognition (OCR) to recognize sheet music. Most music sequencer programs use the XML codes to get the sequence of music right. This is how digitally music is controlled. It is also used to “code” the music. They assign words like “acoustic” and “classical” and “jazz”. And when those are placed in a search engine, the results are Wes Montgomery, Django Reinhardt and Pat Metheny.
Think about that for a second. S1000D uses XML as an “open source” system and tool independent. And provides the structure necessary for implementation of documents and processes across distributed systems. It is powerful without being owned by a company. It is managed by a consortium of people with similar goals in mind — the miscibility of information for the end users.
The S1000D steering committee consists of many participating organizations. The Aerospace and Defense Industries Association of Europe. The International Standards organization for integrated logistics support, the Airlines for America and others.
And all of the documents are required to be delivered in XML format for S1000D. First, before talking about XML, you need to understand how some of the basic terms and definitions from the old days of printed copies and PDF have changed.
eDocuments
Using Word we called it “a document”. Those who pay attention will notice that I used the past tense for using the Word application. For those who obey the rules of Simplified Technical English, we use the present tense. In the world of electronic publishing (epub) we do not create “documents”. We create Data Modules (DMs).
They are called “Data Modules” because it is all about the data. Text, illustrations, dates, part numbers, warnings, cautions, notes. They are all considered data.
In the old days this was the document name. In S1000D it is the Technical Manual Identification Number (TMIN). The identification number has a specific format. We will discuss the naming conventions for the TMIN in detail later, but here are some examples.
Technical writers try to write a document so that the Readers will understand what to do and how things work. And Technical Illustrators try to create graphics so that Readers can see the components and determine the part numbers they need.
S1000D was created to make both the text and graphical data digestible and transferable and understandable by both the Reader and the equipment and software program applications.
The standard for publication is more than just “text” and a “markup language”. The S1000D is all about the data. The whole set of data: maintenance, customer service, shipping and receiving, illustrations, parts, operating manuals and the engineering drawings. All of it linked together in the digital format. At their best, technical writers compile of the data into information that is useful. What good is having the data if it is not readily available at your fingertips. Imagine useful information that does not need to be reentered for other systems. This is far more valuable than being handed “a PDF file” or a thumb drive with all of your data.
This book is written to provide a general working knowledge of S1000 for technical writers and illustrators. Here we present S1000D requirements as if creating the manuals using the old tool MicroSoft Word application. After all, if it is essentially the same information, how different can it be?
As different as night and day.
Headers
They’re called “Page Headers” in Word. The same things in the PDF (Portable Document Format by Adobe) version are called “Running Heads”. However, some of the Software applications for e-books use the term “Viewer Bars”.
Notice the Page Headers include the “security classification”.
TMIN is basically the file name of the document. We will discuss this as a stand alone topic to understand the requirements according to S1000D.
Footers
S1000D requires that Page Footers can contain UP TO three (3) pieces of data. Up to 3 pieces of data and not more.
Change Management
Publications have always involved the process of updating and releasing publications with changes, revisions, deleted text, reinstated stuff. The frequency of updating and releasing publications was decided by project.
Changes were designated using “Change Bars”, the big 4.5 point black bar that was posted next to the stuff that changed.
Reasons for changes are summarized and recorded in the identification and status section. We used to debate if the change bar threshold was more than 50% of the page, which made it hard to read, then we marked the footer as the whole page was “revised” and removed the change bars.
By the time we got to revision Z, Roger lost all his hair. It had become to unmanageable.
For S1000D all of the changes, except for editorial changes, must be marked and provided a reason for update. The reason for update text is used to automatically generate the Revision Summary for the technical manual (TM).
And if you think about it, it makes perfectly good sense that Changes can only be marked for issues that are numbered 002 and above. There are lots of rules in the game of S1000D. This one is just the beginning.
Changes to documentation requires using “elements”. The change element looks like this: . The attributes, or choices for that element, are ‘changeMark’, ‘changeType’, and ‘reaonForUpdateRefIDs’. More on this later.
Issue Numbering
Sometimes referred to as “revision level” for the document, the “initial revision” was designated as “IR” and then it became “Rev A”, and so forth.
S1000D revision tracking is called “Issue Number” and it starts with the draft version which is numbered 000 and when it is approved and ready to release it becomes the original issue 001. The next version becomes issue 002 and the like.
Drafts
Drafts were sent out as “PDF” files and reviewed by the subject matter experts. They ignored these drafts whenever possible. I don’t think anyone likes to read anymore.
With S1000D drafts are designated using the attribute ‘inwork’
The attribute ‘inwork’ for the element is used to track and control the intermediate drafts until the final released issue. The initial “inwork’ number Shall be set to “01” and Shall be incremented with every change to the data module.
Applicability
Applicability specifies parameters and associated data for a particular installation.
For every data module (DM) there are the questions of Applicability. These are the settings to allow the end-user to tailor their view of the publications, by selecting a specific configuration. These are usually physical characteristics such as color or system, component, or piece part. But it can include other aspects of modifications such as the manual change requests (MCR), field changes, repairs, or even environmental conditions.
Bike Example
T he international standards group created a bike example for S1000D.
Way Beyond Word
What makes S1000D far superior to just the written word is the data structure for a Common Source Data Base (CSDB). The closest way I can to describe the difference is that a word document is formed based on a formatting hierarchy. The arrangement of the document is based on the rules of topics broken down into smaller topics. The topics used to be called “First Order Headings”, and topic underneath that was called a “Second Order Heading”. Each of these nested topics would have a formatting assigned to them. The First Order Headings were big and bold. The Second Order Headings were smaller and maybe indented a little. You get the idea.
Common Source Data Base (CSDB)
Common Source Data Base is a structure for data more like a map or a tree. In this structure, “Food” is called the “parent”. “Meat” and “Fruit” are called the “child”. And in a data base, a numerical id would be assigned to each “node”. Databases are used when there is a lot of data so that when it is populated with all the data someone can query the database to display only the information they need to see.
This is the CODB Structure for “Food”. To display the whole “food” tree, they would run the function with an empty string as $parent and $level = 0: display_children (‘ ‘,0); and it would return a list of all of the food. But that level of detail is more than you really wanted to know. So let’s move past the Good Ol’ Days of Word to see how the “data modules” replace “word documents. ”
When the information is obtained from the database it is written in a code. For example this is what it looks like to ask for all of the Customers by Name and Age.
Читайте также: