S1000D Glossary
The only offical S1000D glossary is maintained by the S1000D
Committee and can be found at the S1000D Website (download
the appropriate specification). This glossary is maintained by Crowell Solutions
and contains our own unofficial definitions.
Content Reuse - The ability to use the same
piece of information in multiple locations. Reusing content reduces costs by maintaining
a smaller data set and reducing errors by eliminating multiple versions of the same
piece of information. XML-based environments are particularly adept at achieving
content reuse as mechanisms to link and reference into data exist and are easy to
implement.
Data Module - As stated in the S1000D Specification,
a Data Module is "A self-contained unit of data for the description, operation,identification
of parts or maintenance of the Product and its support equipment. The unit of data
consists of an identification and status section and contents section and is produced
in such a form that it can be input into and retrieved from, a database using the
data module code as the identifier.
Data Module Code - he S1000D specification
defines a Data Module Code (DMC) as "A 17 to 37 character alphanumeric code identifying
the type and the applicability of the data in a data module and enabling it to be
input into and retrieved from, a database.
While DMCs share a number of concepts similar to other numbering schemes (military,
civil aviation), they incorporate additional features used to support modular (chunks)
documentation.
The following graphic breaks down a data module code for the infamous Sopwith Camel
F1:
Note: This is an example. Your data module codes may
look different.
Data Module Code Contents
- Model - Used to indicate the model/overall
system to which the technical data is applicable.
- System Difference Code - Indicates alternative
versions of the system and subsystem/sub-subsystem identified by the SNS without
affecting the type, model or variant identity. Specifically, different codes are
used to identify information that is specific to one unique configuration of a product.
- System - Contains a two digit number
identifying the system that a data module is contained within.
- System - Subsystem/Sub-subsystem - Describes
the further breakdown of system.
- Unit/Assembly Code - Refines the SNS
beyond the System/SubSystem/Sub-Subsystem level. This field is a two digit identifier
used to specify individual units or assemblies.
- Disassembly Code - Identifies the breakdown
condition of an assembly to which maintenance information applies.
- Disassembly Code Variant - Disambiguates
two or more data modules that share the same number and are for the same item at
the same level of disassembly.
- Information Code - Used to identify
the exact purpose of a DM. An information code is a three character code that is
set to a value found in the vast predefined list of information codes defined in
Chapter 8.4 of the S1000D specification.
- Information Code Variant - The Information
Code Variant is used for disambiguating generic information codes to allow for more
specificity.
- Item Location - Location Code indicates
the location of the unit on which maintenance is being performed.
IETM - Interactive Electronic Technical Manual. An ETM is an electronic technical manual such as a pdf while an IETM is more like a web page that allows for non-linear content. It is sometimes pronounced "I eat 'em."
Publication Module - The S1000D Specification
defines Publication Modules as containing"references to data modules, other publication
modules or legacy data) of a publication and its structure.
Single Source Publishing - Publishing to
multiple formats from a single data set. This is a powerful advantage of an XML-based
system as formatting rules are separated from content and are applied when it is
time to publish. As such, from the same data set, content can be formatted for print,
the web, handheld browsers, etc.