How S1000D Works
Information produced in accordance with the standard is in a modular form, called a "data module". This is defined as "the smallest self contained information unit within a technical publication". The important part of this definition is ‘self-contained’. A data module must contain enough information to be standalone, in that it must have sense and meaning when viewed without any supporting data other than graphics.
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 Interactive Electronic Technical Publications (IETP) that is consistent regardless of the IT platform used. Information is not duplicated in the CSDB although individual data modules can be used many times in the output.
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 placed in the CSDB is unique. The standard provides detailed schemas and explanations to guide the determination of the DMC. If used in conjunction with the product breakdown, when creating the project Standard Numbering System (SNS), the DMC also identifies how the subcomponents being documented relate to larger components that comprise a piece of equipment.
A data module comprises two parts: the header and the content sections.
The header contains an identification and status section which contain the metadata (the data about the content). The metadata is that which is required to manage the data module, its source information, security classification, applicability, change history, reason for change, and verification status.
The content section, which is different depending on the data module type, contains actual technical information intended for the user; this can be descriptive, procedural, process logic, a simple list with cross-references, or even the business rules for the project, as contained in the recently introduced Business Rules EXchange (BREX) data module.
The data module types that DTDs and Schemas are provided for are:
|
|
|
|
|
|
|
|
|
|
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.
It is these tags and their attributes that provide the functionality that allows the information to be presented dynamically in the IETM, they provide the mechanism by which the logic and behavior required for the IETM to display the information is determined.
Using SGML or XML to tag information required solely for the printed page, or a linear IETM, would only require the information to be marked with tags that define that type of structure. i.e. chapters, paragraphs, warnings, cautions, tables, lists etc.
By using such tags and attributes as applicability, Boolean, variable and the numerous tags in the process data module S1000D allows for a much more dynamic and interactive presentation of information within the IETM.
For more information on how CDG can provide S1000D documentation services for you, contact us.
S1000D™ is a registered trademark of ASD.
