S1000D

Last updated

S1000D is an international specification for the procurement and production of technical publications. It is an XML specification for preparing, managing, and publishing technical information for a product. It was initially developed by the AeroSpace and Defence Industries Association of Europe (ASD) for use with military aircraft. Since Issue the scope has been extended to include land, sea and even non-equipment products. It is widely used in civil as well as military products. S1000D is part of the S-Series of ILS specifications.

Contents

S1000D is maintained by the S1000D Steering Committee, [1] which includes board members from ASD, the United States' Aerospace Industries Association (AIA), and the Air Transport Association (ATA), along with industry and defence representatives from most of the countries currently using the specification. The specification is free to download and use, although commercial products and services are available.

Main principles

S1000D requires information to be created as individual data items, called data modules (DM), which are structured with XML elements and metadata. Each DM is self-contained and may be used wherever that piece of information is needed. They are organised into an hierarchical XML structure through the use of data module coding. This permits the updating of single data items without necessarily changing the path in the XML structure which points to them. Knowledge so partitioned and classified can therefore be shared among many publications, and updating of items in the underlying controlled source will automatically affect updating of the dependent publications. The actual XML hierarchy must be designed specifically for each different knowledge domain.

The DMs and supporting contents (graphics, multimedia, publishing information, training packages, etc.) are usually stored and maintained using a Common Source Database (CSDB). This is the database for the containment and management of data modules. The CSDB will typically contain all the components required for a product's Interactive Electronic Technical Publication (IETP) - which is all the elements required across all disciplines for the production of a suite of documentation for the operation and maintenance of the product. S1000D only states that there must be a database, it does not define the funktionallity. [2]

Another common term often related to S1000D is Interactive Electronic Technical Manual (IETM) which is usually considered as an individual manual that is part of the IETP. Due to the flexibility of XML, these IETM may range from a printed (paper or simple page-presentation) manual, through to a fully interactive digital manual with rich media, learning opportunities, and multiple formats of delivery.

Associated specifications

S1000D is part of the S-Series of ILS specifications. There is an interface specification with S3000L Issue 1.0, [3] titled S1003X [4]

For S1000D content in English, the language should adhere to Simplified Technical English standard ASD-STE100. [5]

Availability

S1000D can be downloaded for free at its project website .

History

Prior to Issue 2, updates to the specification were known as changes. When the standard reached Change 9, the proposed Change 10 became Issue 2.0 with previous Changes retro-referred to as Issue 1.x. Issue 1.6 was the first publicly published version of S1000D and was notable as the first issue to include operator information (Crew) as well as maintainer content.

Change history of S1000D
IssueDateBase languageAmendments
1.631 March 1995SGML DTD

not available for download

1.701 February 1998SGML DTD1.7.1 dated 2 July 1998 (introduces IPRF DTD)
1.831 January 1999SGML DTD1.8.1 dated 31 May 2000 (various DTD changes)
1.901 April 2001SGML/XML DTD
2.031 May 2003SGML/XML DTD, XML schemaThere is a patch folder, but no official numbered patch and it only contains an updated data dictionary.
2.129 February 2004SGML/XML DTD, XML schema
2.201 May 2005SGML/XML DTD, XML schema2.2.1 dated 01 May 2006 (XML schema only)
2.328 February 2007SGML/XML DTD, XML schema2.3.1 dated 01 February 2009 (various schema problems fixed)
3.031 July 2007SGML/XML DTD, XML schema3.0.1 dated 01 February 2009 (various schema problems fixed)
4.001 August 2008XML schema4.0.1 dated 12 May 2009 (extensive changes, updated BREX)

4.0.2 dated 09 October 2013 (various changes, updated BREX)

4.131 December 2012XML schema4.1.A dated 7 November 2014 (corrects error in Crew schema, IPD fig number and BREX problems)

4.1.B dated 30 June 2017 (updated BREX rules)

4.1.C dated 12 May 2020 (adds back missing Warning and Caution CIR infoCodes)

4.1.D dated 27 April 2023 (replaced .swf files in Bike data with .gif)

4.231 December 2016XML schema4.2.A dated 31 May 2019 (specification only; no schema changes)
5.028 June 2019XML schema5.0.A dated 01 November 2019 (specification only; no schema changes)

5.0.B dated 29 September 21 (data dictionary update only)

6.001. September 2024XML SchemaPossibilities for references

Introduction of a new SVG profile

Introduction of a new, modernized S1000D logo

Introduction of new S1000D issue number convention

S1000D does not provide, nor endorse any software tools to produce or distribute content in accordance with the standard.

See also

Related Research Articles

<span class="mw-page-title-main">RSS</span> Family of web feed formats

RSS is a web feed that allows users and applications to access updates to websites in a standardized, computer-readable format. Subscribing to RSS feeds can allow a user to keep track of many different websites in a single news aggregator, which constantly monitors sites for new content, removing the need for the user to manually check them. News aggregators can be built into a browser, installed on a desktop computer, or installed on a mobile device.

MARC is a standard set of digital formats for the machine-readable description of items catalogued by libraries, such as books, DVDs, and digital resources. Computerized library catalogs and library management software need to structure their catalog records as per an industry-wide standard, which is MARC, so that bibliographic information can be shared freely between computers. The structure of bibliographic records almost universally follows the MARC standard. Other standards work in conjunction with MARC, for example, Anglo-American Cataloguing Rules (AACR)/Resource Description and Access (RDA) provide guidelines on formulating bibliographic data into the MARC record structure, while the International Standard Bibliographic Description (ISBD) provides guidelines for displaying MARC records in a standard, human-readable form.

The International Press Telecommunications Council (IPTC), based in London, United Kingdom, is a consortium of the world's major news agencies, other news providers and news industry vendors and acts as the global standards body of the news media.

ASD-STE100 Simplified Technical English (STE) is a controlled language designed to simplify and clarify technical documentation. It was originally developed during the 1980's by the European Association of Aerospace Industries (AECMA), at the request of the European Airline industry, who wanted a standardized form of English for technical documentation that could be easily understood by non-English speakers. It has since been adopted in many other fields outside the aerospace, defense, and maintenance domains for its clear, consistent, and comprehensive nature. The current edition of the STE Specification, published in April 2021, consists of 53 writing rules and a dictionary of approximately 900 approved words.

<span class="mw-page-title-main">Technical writing</span> Type of written communication

Technical writing is a specialized form of communication used by many of today's industrial and scientific organizations to clearly and accurately convey complex information to a user. An organization's customers, employees, assembly workers, engineers, and scientists are some of the most common users who reference this form of content to complete a task or research a subject. Most technical writing relies on simplified grammar, supported by easy-to-understand visual communication to clearly and accurately explain complex information.

ISO 10303 is an ISO standard for the computer-interpretable representation and exchange of product manufacturing information. It is an ASCII-based format. Its official title is: Automation systems and integration — Product data representation and exchange. It is known informally as "STEP", which stands for "Standard for the Exchange of Product model data". ISO 10303 can represent 3D objects in Computer-aided design (CAD) and related information.

Integrated logistics support (ILS) is a technology in the system engineering to lower a product life cycle cost and decrease demand for logistics by the maintenance system optimization to ease the product support. Although originally developed for military purposes, it is also widely used in commercial customer service organisations.

'ATA Spec 100' and iSpec 2200 are information standards for aviation maintenance and flight operations published by Airlines for America.

An interactive electronic technical manual (IETM) is a portal to manage technical documentation. IETMs compress volumes of text into just CD-ROMs or online pages which may include sound and video, and allow readers to locate needed information far more rapidly than in paper manuals. IETMs came into widespread use in the 1990s as huge technical documentation projects for the aircraft and defense industries.

A Common Source Database (CSDB) is to provide the user with automated processes to handle the complete palette of CSDB objects. Technical documentation is used in many areas of the everyday life. Product liability and many other issues regarding consumer protection have to be covered inside technical documentation. At minimum, a drawing including a few locators has to be provided. Much of this information is in accordance with the international S1000D specification.

A specification often refers to a set of documented requirements to be satisfied by a material, design, product, or service. A specification is often a type of technical standard.

This military standard established the Standard Generalized Markup Language (SGML) and the Extensible Markup Language (XML) requirements for use in Army digital publications. Within this military standard, Army publications SGML/XML requirements are separated by publication types. There are specified sections for administrative publications, training and doctrine publications, technical and equipment publications and Global Combat Support System-Army (GCSS-A). This new publication of the standard contains the XML requirements for Technical Manuals (TM) developed in accordance with the functional requirements contained in MIL-STD-40051-1 and MIL-STD-40051-2, GCSS-A collection and reporting of maintenance data developed in accordance with MIL-STD-3008, and administrative publications developed in accordance with AR 25–30. The XML requirements are applicable for the development, acquisition, and delivery of Electronic and Interactive Electronic Publications (EP/IEP) such as Electronic and Interactive Electronic Technical Manuals (ETM/IETM). The previous SGML for training and doctrine publications functional requirements, developed in accordance with TRADOC Reg 350-70 and TRADOC Reg 25–36, remain unchanged. Specific Interactive Multimedia Instruction (IMI) functionality is currently contained in MIL-PRF-29612, The Development and Acquisition of Training Data Products and TRADOC Reg 350–70, Systems Approach to Training Management, Processes, and Products.

<span class="mw-page-title-main">EPUB</span> E-book format

EPUB is an e-book file format that uses the ".epub" file extension. The term is short for electronic publication and is sometimes stylized as ePUB. EPUB is supported by many e-readers, and compatible software is available for most smartphones, tablets, and computers. EPUB is a technical standard published by the International Digital Publishing Forum (IDPF). It became an official standard of the IDPF in September 2007, superseding the older Open eBook (OEB) standard.

Technical documentation is a generic term for the classes of information created to describe the use, functionality or architecture of a product, system or service.

A component content management system (CCMS) is a content management system that manages content at a granular level (component) rather than at the document level. Each component represents a single topic, concept or asset.

Shipdex is a collection of international business rules developed to standardize and improve the production and the exchange of technical information between equipment makers, shipyards and ship-owners according to international S1000D specifications already in use for about 30 years in the military sector and adopted more recently by Civil aviation. It enables equipment manufacturers and shipyards to structure, write and deliver technical manuals, and to load ERP and CMM systems with technical manual contents into a standardized electronic format, making them much easier to produce and manage, compared to traditional methods of writing technical manuals using a word processor.

SX000i - International guide for the use of the S-Series of Integrated Logistics Support (ILS) specifications, is a specification developed jointly by a multinational team from the AeroSpace and Defence Industries Association of Europe (ASD) and Aerospace Industries Association (AIA). SX000i is part of the S-Series of ILS specifications.

The S-Series of ILS specifications is a common denominator for a set of specifications associated to different integrated logistics support aspects. Originally developed by AECMA, the S-Series suite of ILS specifications is managed currently jointly by multinational teams from the AeroSpace and Defence Industries Association of Europe (ASD) and Aerospace Industries Association (AIA) reporting to the AIA/ASD ILS Council. The ILS Council established the term S-Series (of) ILS specifications as the common denominator for all its specifications, and this term was consolidated with the publication of SX000i.

S4000P - International specification for developing and continuously improving preventive maintenance is a specification developed jointly by a multinational team from the Aerospace and Defence Industries Association of Europe (ASD) and Aerospace Industries Association (AIA). S4000P is part of the S-Series of ILS specifications and is integrated in the global ILS process defined by SX000i - International guide for the use of the S-Series of Integrated Logistics Support (ILS) specifications.

References

  1. ↑ S1000D official homepage
  2. ↑ "About S1000D – S1000D" . Retrieved 2024-09-09.
  3. ↑ S3000L, "International procedure specification for Logistics Support Analysis LSA", April 2010, published by ASD/AIA
  4. ↑ S10003X, "S1000D to S3000L Interchange specification", March 2011, published by ASD/AIA
  5. ↑ "The official home of ASD Simplified Technical English, ASD-STE100 (STE)" . Retrieved 30 January 2014.
This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.