Why Create Data Modules - Automation and Reuse
SDL.com
Why Create Content as Data Modules

Why Create Content as Data Modules

One of the primary benefits of data modules is the ability to reuse them across multiple publications and publishing outputs.

As you can imagine, working with data modules rather than documents is a significant paradigm shift for authors, editors, reviewers, and frankly anyone who is working within a technical publications organization.  So what is the benefit of working with data modules and adjusting to a completely different way of creating documentation?

Automation and Reuse
Because data modules are identified and written according to component and information type, it is very easy to reuse data modules across multiple publications and publishing outputs. When a data module is updated, that change impacts every publication in which that data module occurs.

Because data modules contain identical metadata across all data module types and have data module codes that identify the component and type of information, it becomes easy to pre-populate much of the metadata and even some of the content in a data module simply by interpreting the information in the data module code. This is accomplished by means of a Data Module Requirements List (DMRL)—an S1000D concept used for document planning—which identifies the systems associated with each component of the Data Module Code. The DMRL can be loaded into a Common Source Data Base to establish the information requirements for the entire project; and based on the DMRL, all of the needed data module objects can be pre-created in the appropriate hierarchy in the CSDB.

What this means is that by the time an author is prepared to write about a component, there is already a data module object in the CSDB with all or most of the needed metadata (revision information, inwork status, security classification, etc.) and some of the content pre-populated. The data module object in the CSDB can also be pre-populated with the appropriate XML tagging structure, so the author simply needs to apply the content for the module (e.g., the installation procedure for a brake rotor) into the correct XML elements and check it back into the CSDB.

S1000D
S1000D

S1000D is an international standard for procuring and producing technical documentation. Included in the specification are prescribed methods for interchanging, managing, and publishing technical content.
What is S1000D
What is S1000D

In the most simple terms, S1000D is a suite of information that includes a 2,762-page specification (Issue 4.0), a set of XML schemas, sample XML instances, and additional supporting documentation.
Where is S1000D Used
Where is S1000D Used

S1000D has been heavily used for quite some time to support aviation documentation in the European defense community.

The Common Source Database (CSDB)
The Common Source Database (CSDB)

Not all CSDBs are alike, but at a minimum they should have the ability to import, manage, and export valid S1000D XML.
Interactive Electronic Technical Publications (IETPs)
Interactive Electronic Technical Publications (IETPs)

An IETP can filter the content a user sees as runtime based on criteria such as equipment, skill level, and environmental conditions.
How To Get Started with S1000D
How To Get Started with S1000D

S1000D Workshops, Webinars and Training offer an excellent foundation for developing your S1000D strategy.