S1000D

 What You Should Know About S1000D The Background and Benefits of this Revolutionary Standard © Continental DataGraphics - All rights reserved. ww.cdgnow.com w Table of Contents Introduction.........................................................................................................................1 S1000D – Then and Now....................................................................................................2 Paper vs. Interactive Electronic Publications......................................................................3 TMSMG Guide for Classes of Publications.....................................................................3 How Does S1000D Work? How is it Applied?...................................................................4 A Modular Approach........................................................................................................4 Data Modules..................................................................................................................5 Data Module Codes.....................................................................................................6 High Level Benefits.............................................................................................................7 About CDG..........................................................................................................................8 © Continental DataGraphics – All rights reserved. Introduction For those in the technical publications field, there is a minor revolution coming your way. The minor revolution is called S1000D. You may have heard the name S1000D before, but may not be sure exactly what it means. On a high level, S1000D is a single multinational specification that provides standards and guidelines for the production of technical publications. You might think of it as a “roadmap” that technical information authors can use to guide them through the process of building a technical publication. S1000D also provides a well defined method of exchanging technical information between multiple suppliers and between suppliers and customers. S1000D was originally created in the European aerospace community, and has been widely used across Europe for several years. More recently, the S1000D standard has gained notoriety in the US as well, and is now being implemented and adopted by a growing number of both military and commercial industry groups across the US. Although currently targeted at technical publications, practical usage has proven that the specification’s basic principles of data re-use also have much wider applications for all types of publications. The following overview will attempt to cover some of the most basic questions that are often asked by newcomers to the S1000D arena, such as: • What is S1000D? • • • • How does it work when applied to technical publications? What are the advantages and benefits to using it? Who stands to benefit from its use, and how? What is involved in adopting S1000D? Read on to discover more about this revolutionary publications specification. 1 S1000D – Then and Now The full name of the specification is actually “The International Specification for Technical Publications Utilising a Common Source Data Base – Specification 1000D”, commonly known as S1000D. S1000D was initially developed in 1984 by the Association Européenne des Constructeurs de Matériel Aérospatial (AECMA), (The European Association of Aerospace Industries). AECMA represented the aerospace industry of fifteen European Union nations in common technical interest matters. The group started with the Air Transport Association (ATA) Spec 100, which was widely used in the commercial aviation community, and used it as the basis for development of a new European military specification. This new specification was first released in 1986, and given the name Spec 1000D. A total of nine revisions to Issue 1 of the spec were released over the years, and finally, in 2003, Issue 2.0 was released. The spec began to be commonly referred to as S1000D. Issue 2.0 version incorporated a major restructuring of the spec, and added options of XML schema in addition to SGML DTDs. Issue 2.0 also addressed support of land and sea systems and the use of the spec became free of charge. Today, the S1000D standard is supported by the successor to AECMA, the AeroSpace and Defence Industries of Europe (ASD) and the Aerospace Industries Association of America (AIA). It is controlled by the Technical Publications Specification Management Group (TPSMG), which has the full responsibility of maintaining the specification. The TPSMG includes members from both government agencies and industry. To address the rapid development of information technology, a group of specialists, the Electronic Publications Working Group (EPWG), supports the TPSMG in technical matters. Recently, the original contributions of the ATA (Air Transport Association) of its SPEC 100 as the basis for the S1000D specification have come full circle. In June of 2005, the ATA signed a memorandum of understanding with the Aerospace & Defense Industries Association of Europe (ASD) and Aerospace Industries Association of America, Inc. (AIA) to collaborate on the development of publication standards for aviation maintenance. The stated goal behind this agreement is to incorporate commercial aviation requirements (currently addressed by the ATA’s iSPEC 2200 and envisioned in the Future Data Exchange project) into S1000D, and establish a single specification for both military and commercial aviation industries worldwide. Although currently targeted at technical publications, basic principles of data re-use in S1000D could also have much wider applications for all types of publications. Even the US Internal Revenue Service (IRS) and the Federal Aviation Administration (FAA) are experimenting with use of the specification on document management initiatives. S1000D is already widely used by the European military community, and is in fact mandated by the UK Ministry of Defence (UK MoD) as the required specification for delivery of technical documents supporting any large scale military programs. There are also a few US military programs that have already adopted S1000D, such as the Air Force F-117A and Global Hawk unmanned vehicle programs, the Naval Air Systems Command Joint Strike Fighter (JSF) program, and the Army Future Combat System. Recently more Requests for Proposals (RFPs) from US military programs are also starting to include delivery of S1000D publications as a requirement for contractors submitting bids on the proposals. 2 What You Need To Know About S1000D Paper vs. Interactive Electronic Publications Technical publications can be distributed in a number of different ways and via different media. The two primary categories for technical publications distribution are either (1) traditional “page-oriented” publications (for delivery on paper), or (2) Interactive Electronic Technical Publications or Manuals (referred to as IETPs or IETMs). A common terminology has emerged by which to categorize different types of publications according to their level of complexity (with regard to functionality for users). As depicted in the table below, publications are referred to at a high level as either Type I or Type II. Within each Type, there are specific Classes of publications. Class 0, I, II, and II are designated under the Type I category, and Class IV and Class V publications are assigned as Type II publications. The Type I publications generally adhere to a more traditional “page-oriented” presentation method, while Type II publications provide for delivery of fully interactive electronic manuals, with varying degrees of integration with other systems and resources as well. While Class V publications may be seen as the “utopia” or “holy grail” of technical publications that most manufacturers (and equipment users) would like to achieve, the reality is that today very few programs have successfully implemented Class V publications in accordance with their pure definition. TMSMG Guide for Classes of Publications Type I Type II Class 0 Class I, II, III Class IV Class V Media Delivery Method Paper Electronic Interactive Class IV Technical Electronic IETM plus Manual Technical Electronic (ETM) Manuals Infrastructure(IETM) Formatting/Presentation Multiple Electronic Fully IETM is Methods volumes Emulation of Interactive linked to Paper IETM Maintenance Manual Systems Level of Integration Not linked May include Includes Integrated Capabilities or electronic functionality to with Intrusive integrated page turner automatically Diagnostics at all and guide a Systems hyperlink maintainer functionality through a maintenance troubleshooting process Unlike most prior publication standards, S1000D is not exclusively focused upon the traditional concepts of a publication being structured based solely upon page-oriented “book” elements such as chapter, section, subsection, page, etc. The current ATA (Air Transport Association) iSpec 2200, could be considered a standard for delivery of Type I publications, as it is still largely based upon the premise of a technical publication being a published “book” (supporting a page-oriented format). Specific chapter numbers, sections and subsections in publications are designated as the primary identifiers to designate how certain pieces of equipment and/or repair processes related to that equipment are presented, and in what sequence. Background and Benefits of This Revolutionary Standard 3 As an example, in an ATA standards-compliant Illustrated Parts Catalog for commercial aircraft, Chapter 32 always contains information about landing gear equipment and parts. This is true across the board, without regard to which manufacturer produced the aircraft, or which model of aircraft. Likewise, in the Aircraft Maintenance Manual, Chapter 32 always addresses the repair and maintenance procedures for …..you guessed it – the landing gear. So with the ATA iSpec 2200 and other standards, the structure of the “book” or the standard appearance of each page itself dictates how the information is tagged and organized. The end result is that in most cases, new technical documents are written and maintained independently as standalone “books” for each individual product, without regard to whether the document may contain components or subcomponents that are also used in other similar products (or publications) as well. In its early phases of development, the Spec 1000D standard was designed to support page-oriented publications (Type I). As electronic publishing and database technologies evolved, S1000D was later adapted to also encompass delivery of electronic publications with a high level of interactive functionality (Type II). S1000D is focused on individual, re-usable data elements, or data modules that are not necessarily associated with a page-oriented organization structure. However, S1000D can still support output in a paper-based “book” type structure (Type I) if required. With S1000D, the header and content sections of a data module are tagged in accordance with relevant S1000D SGML Document Type Definitions (DTDs) or XML Schemas as defined by the standard. It is these electronic tags and their attributes that provide the functionality that allows the information to be presented dynamically in an Interactive Electronic Technical Publication (IETP). In an IETP, data does not necessarily have to be presented in a static, page-oriented format, but can in fact be dynamically generated “on the fly”, based upon product configuration, operating conditions, and other “knowledge” obtained by other systems (such as a Maintenance Management System) or entered by a user of the IETP system. Individual data elements are “called up” over and over as needed to be presented in different display scenarios and publications. With an IETP, the very same landing gear data module that appears in a parts catalog may be retrieved again to appear in the troubleshooting or fault isolation manual, depending on what type of information the user wants to view. How Does S1000D Work? How is it Applied? A Modular Approach As discussed previously, S1000D differs from some other standards in that it is based on the principle of a data module, and not centered on the premise of delivery of a published (paper-based) book. A data module is defined as “the smallest self-contained information unit within a technical publication”. The most important part of this definition is ‘self-contained’. Each data module must be able to stand alone or be integrated into a larger publication. It must contain enough information to be standalone, in that it must have sense and meaning when viewed without any supporting data other than graphics. On a technical level, each data module must contain identification and status metadata about itself, as well as actual technical content. 4 What You Need to Know About S1000D The size of a data module is not mandated, but a module typically represents one discrete task, ranging from a couple of steps to many. For example, turn off electrical power, open access panel, and remove unit may each be created as a separate data module. You might be asking “Why not create all three of these related steps as a single data module?” If all of these three items were created as a single data module, then individual common tasks such as turning power off could not be easily reused and shared. All data modules that are applicable to the subject equipment are stored and managed in a database, which is referred to as the Common Source Data Base (CSDB). The benefit of a CSDB is to enable production output in either page-oriented or an Interactive Electronic Technical Publication (IETP) that is consistent regardless of the IT platform used. Information is not duplicated in the CSDB although individual data modules can be used and reused many times in the output. Data Modules Every data module has a unique data module code (DMC) that serves as an identifier and provides a mechanism for preventing duplication of data. Along with the issue number the DMC also ensures that every data module in the CSDB is unique. The standard provides detailed schemas and explanations to guide the determination of the DMC. S1000D uses a Standard Numbering System (SNS), tailored for each project. This SNS is aligned to the product structure, therefore because the SNS forms part of the DMC. The DMC also identifies how the sub-components being documented relate to the other components that comprise the product. Currently, S1000D data modules are structured to represent eight specific types of data. The IDSTATUS section of every data module is identical; only the CONTENT section is different. The data module types that DTDs and Schemas are provided for are: 󰂃 Descriptive Information 󰂃 Procedural Information 󰂃 Crew/Operation Information 󰂃 Fault Information 󰂃 Maintenance Planning Information 󰂃 Illustrated Parts Data 󰂃 Wiring Data 󰂃 Interactive Procedural Information 󰂃 Business Rules Exchange In the upcoming S1000D Issue 2.3, several more data module types will be added. These new data module types are a break from the traditional view of a publication. They provide capabilities more in line with supporting data management and reuse. The new data module types that DTDs and Schemas are provided for are: 󰂃 Alternate DM Container 󰂃 Product Cross Reference Information 󰂃 Technical Condition Cross Reference Information 󰂃 Technical Repository Information All information in both header and content sections of a data module is tagged in accordance with the relevant S1000D SGML Document Type Definition (DTD), or XML DTD or Schema as defined by the standard. Background and Benefits of This Revolutionary Standard 5 It is these tags and their attributes that provide the functionality that allows the information to be presented dynamically in an IETM. They provide the mechanism by which the logic and behavior required for the IETM to display the information is determined. Data Module Codes Data modules are identified by a Data Module Code (DMC). The DMC is used within the IDSTATUS section to identify the data moduel, and is also used to form the SGML or XML source file name. The DMC is structured as follows: Structure of an S1000D Data Module Code (DMC)YYYYYYYYYYYYYYModel Identification CodeSystem Difference CodeStandard Numbering SystemDisassembly CodeDisassembly Code VariantInformation CodeInformation Code VariantItem Location Code__YYYY__YYY-YY-YYYY__YYYYY__YYYY__YThe Data Module Code (DMC) is comprised of a total of 37 characters. Each section of the code identifies a specific portion of the information. In addition to the DMC, the identification also includes a title, issue number, issue date, and optional language. By analyzing this structure, one can tell (1) what product the data pertains to, (2) where the assembly that this data pertains to fits into the functional breakdown of the product, (3) where in the sequence of disassembly the task fits, and (4) what the detailed type of task is. S1000D is very specific on the DMC coding scheme. In fact, it devotes approximately 800 pages of the specification just to this one topic! 6 What You Need to Know About S1000D High Level Benefits Most experts will agree that the single greatest benefit offered by S1000D is the ability to reuse data. Reuse of data is in fact one of the primary drivers behind why S1000D was created in the first place. Similar to the stated vision of CALS in the past, the mantra of S1000D proponents has also become: “Create once, use many times.” With S1000D, once you have created a specific data module (containing either text or graphics), the data module is then stored in the Common Source Database (CSDB). You can then reuse and redistribute that very same data module in many other different projects or publications. This can bring a tremendous amount of time savings to the authoring process, as data modules are simply “plugged in” to any publication or project documentation as needed. Even greater gains can be realized through the life cycle of a long term project. Changes to the technical data only have to be made in one place as opposed to everywhere that data is used. In short, with S1000D there is no longer a need to recreate the same information over and over again for each individual publication. For example, the same descriptive information about a radar system that appears in a Flight Operations Manual used by pilots could also easily be inserted or referenced in a Maintenance Manual used by technicians, or an Illustrated Parts Catalog used by a parts procurement or inventory specialist. Three different publications, the same data, authored only once. As the technical publications world continues to transition away from delivery of paper manuals in favor of more interactive electronic technical manuals, leading standards like S1000D have become essential, and the driving force to support this technology trend. Yet it is important to note that the S1000D standard is also extremely flexible, in that it can easily support delivery of publications in a variety of electronic formats, while continuing to support delivery of traditional paper-based publications as well. As the transition from legacy paper publications to electronic delivery doesn’t always happen overnight, S1000D is ideally suited as a “roadmap” to support organizations throughout this transition process. The revolutionary thinking behind the development of the S1000D standard is today beginning to come full circle, by bringing its substantial benefits to numerous military and commercial publications projects worldwide. Background and Benefits of This Revolutionary Standard 7 About CDG With over 35 years of experience with large scale technical publications and data management projects, CDG has extensive knowledge of many widely recognized publications standards for both commercial and military publications, including S1000D. CDG was the first technical publications provider to apply the S1000D standard to land-based defense systems in the U.K. Over the course of its history, CDG has dedicated itself to continual development of innovation and expertise in technical data management services. Recognizing the growing demand for S1000D standards based support services, CDG has made a firm commitment to continually enhance its S1000D technical authoring and consulting services capabilities worldwide. CDG is committed to proactive support of the further development of the S1000D standard, and has allocated dedicated CDG representatives serving in prominent positions on the Electronic Publications Working Group (EPWG) in both the U.S. and Europe, as well as the U.S. Implementation Group. CDG’s S1000D support services include: • S1000D Technical Authoring and Conversion Services – CDG’s highly skilled technical publications specialists have proven experience in authoring of S1000D-based publications and conversion of legacy publications into S1000D compliant format. • S1000D Consulting Services – to assist organizations with the writing and development of business rules to support S1000D-based projects. Today, as a wholly owned subsidiary of The Boeing Company, with multiple locations in the U.S. and Europe and over 1,000 employees, CDG has grown to become a leading provider of products and services for the creation, conversion, management and delivery of data and information. Though originally focused on the commercial aviation sector, CDG’s customer base today encompasses a broad and diverse mix of industry sectors, including Aerospace and Defense, Government, Manufacturing, and Enterprise Business. CDG’s US-based facilities utilize an ISO 9001-certified Quality Management System. Our UK facilities have received an ISO BS EN9001/2000 accreditation for quality management. With an extensive volume of work performed for government agencies, the defense sector, airlines, and financial services companies, CDG facilities adhere to stringent security standards, ensuring confidentiality of proprietary and sensitive information. 8 What You Need to Know About S1000D Contact us for more information about CDG services and solutions: www.cdgnow.com sales@cdgnow.com U.S. Europe Telephone: (714) 503-4200 Outside UK: +44 (0) 1707 392520 Within UK: 01707 392520 Fax: (714) 827-5111 Outside UK: +44 (0) 1707 371813 Within UK: 01707 371813 CDG CDG Ltd. 6141 Katella Avenue Gate House, Fretherne Road Cypress, CA 90630-5202 Welwyn Garden City USA Hertfordshire AL8 6NS, United Kingdom Background and Benefits of This Revolutionary Standard 9 S1000D-WP1-05-06 www.cdgnow.com