TECHNICAL PUBLICATIONS S1000D STANDARD BY BAeHAL SOFTWARE LTD
Graphical Representation of Legacy world and S1000D world
In S1000D, the content is developed as reusable “chunks” known as Data Modules (DM). Each data module typically represents a task, which may range from a couple of steps to many steps with a unique identification called as Data Module Code (DMC).
::The Data Module developed as per S1000 D is capable of supporting integration into a larger publication, such as a book or an interactive electronic Technical publication (IETP)
This modular approach is a deviation from the traditional page-oriented elements such as book, chapter, section, sub-section, page, etc.
It moves technical documentation away from the document-centric approach to a more data-centric approach and promotes content reuse. The data modules are stored in a database known as a Common Source Data Base (CSDB). The CSDB also stores other assets associated with a documentation project such as graphics, multimedia files etc.
S1000D uses the Extensible Markup Language (XML), Standard Generalized Markup Language (SGML), and Computer Graphics Metafile (CGM) for producing and using documentation that support the maintenance and operation of complex equipment, machinery and systems.
COMMON SOURCE DATA BASE (CSDB):
CSDB is a virtual store for the data modules, publication modules and graphical objects . The Aim of a CSDB, in accordance with specification S1000D is to provide the user (mainly technical authors, illustrators and publication managers) with automated processes to handle the complete objects involved in publication.
A project’s complete technical information set is held on a CSDB. The key element in information management is the CSDB. It is an information store and management tool for all objects required to produce the technical publications within projects.
The combination of DMC, Information types and DM metadata allows a selection of subsets of information to be chosen by query or table of contents designed to meet a user’s needs.
DATA MODULE REQUIREMENTS LIST (DMRL)
DMRL is used in S 1000 D to ensure the accurate acquisition of all projects’ contents. DMRL is an XML file that lists every data module code (DMC) used in the project. The DMRL is used to validate the data requirements specified in the statement of work are delivered to the customer. The DMRL supports planning, reporting, production and configuration control.
FILE NAMING CONVENTION
S1000D files are named according to the DMC. Each data module contains a discreet piece of information supporting a discreet aspect of a system. A discreet piece of information is a thematically related set of content mapped to a particular task (e.g. changing oil in an engine, a list of materials associated with an operation, or a test procedure for surface cracks using magnetic materials). The data module name is semantically discreet based on naming conventions in the specification. The data module name retains its integrity even as a system is deployed to multiple platforms.
Naming conventions in an XML-based specification like S1000D are possible when structures are standardised according to industry conventions
There are two other naming conventions specified in S1000D. Those conventions are applied to illustrations and publication modules (PM). Illustration names are referred to as “information control numbers” (ICN). The ICN contains a collection of alpha-numeric metadata that when strung together forms the name of a graphic, schematic, or other visual representation of a system. The is the link between an illustration, a publication and parts lists..
DATA MODULES TO PUBLICATIONS
A Publication Module contains a naming convention called a Publication Module Code (PMC). The PMC contains a collection of alphanumeric metadata that when strung together forms the name of collection of data modules intended for distribution.
: PMC may identify an entire manual, or may define a discreet set of tasks that entail a collection of modules intended for distribution. The PMC represents the aggregation of content used for a unique purpose
The publication module works as a data module gathering point structured in XML. It is a flexible aggregation tool that allows a publication to be of any size and used for any purpose. The publication module will not know or care whether the collection is for training, or for on-demand data, or for a 5000 page catalog. It is also unaware if the output product will be linear or non-linear. Furthermore, the publication module contains its own naming convention.
DATA REUSABILITY
The Data Module (DM) information architecture in S1000D enables technical data to be chunked into small files. The publication module for the creation of unique output products can aggregate these files. Therefore, one or more publication modules can refer one data module. This is the reuse mechanism in S1000D, a mechanism that allows for technical data content to be inserted into supporting courseware without the expense of data transformation from one format to another.
Data reuse does not happen on its own. Technical authors and data managers must be aware of and plan for content to be used in multiple outputs. Whether the reused content is in support of multiple configurations, the reuse of technical information in training products, or the reuse of unique graphics and multimedia across a suite of products, coordinating the reuse must be implemented in the publication module.
Inherent in the reuse objective is cost savings. The reuse can achieve the objective of “buy once, use many times.” The ability to track common content across information products relieves the acquisition manager of repurchasing the same data if it is deployed to multiple outputs. At the same time, a data manager can assess which of the reused data modules affect various technical publications.
BUSINESS RULE EXCHANGE (BREX)
BREX is the S1000D concept for exchange of the business rules adopted by a project or an organization implementing the specification. The BREX data module provides a structure for standardized formal exchange and unambiguousdefinition of such rules.
As S1000D has evolved to support multinational customers across both military and civil programs, it has also become significantly more complex and flexible. Due to the complexity and flexibility, there is a requirement to document and enforce rules to ensure that projects adhere to a defined set of variables for authoring, interchange and delivery
A well-articulated BREX is a documented XML file for implementing S1000D within projects and it absolutely ensures data interoperability and consistency, and it supports delivery according to customer requirements. This is where S1000D Business Rules come into play.
Business Rules are used to facilitate a successful S1000D implementation and provides guidance on how to approach Business Rule development. It explains the difference between Business Rules and BREX and provides tips on how to avoid some common and costly mistakes when developing your S1000D Business Rules.
ADVANTAGES OF S1000D
Ensuring system design changes and system documentation are concurrent
Reducing maintenance costs for technical information
Allowing a subset of information to be generated to meet specific user needs
Generating many different output forms from the same base data set which ensures strong and efficient data configuration at the user interface level
Allowing neutral delivery and data management,.
Reducing support costs, provides content modularity and reuse
Enabling data sharing across different computing platforms
Allowing users to view electronic documentation via a common web browser or text viewer.
SUMMARY
The future of publications depends on web enabled reusable source files of publications, which are interoperable in an agile distribution system. The unifying effect of S1000D reduces the technical difficulties for data management because Common Source Data Base (CSDB) and web services will serve as technical interfaces to business processes. Accessibility is the key to delivering the right data to the right person at the right time.
The precision required to deliver the right data at the right time can only be derived from a refined information naming system that turns data into configuration items. For the first time, the publications and the training contents can be configured together so the global impact on system documentation can be determined from a single Change Notice (CN).
BAeHAL has thorough domain expertise and a fully trained team who can take up any project on S 1000 D standards including converting from different standards to S1000D or creation of S1000D documents afresh from the design documents of any industry.
BAeHAL can customize the Common Source Data Base (CSDB) with required configuration so that the different Publication Modules’ stylesheet can be made as required by the customer.
As S1000D addresses and resolves many issues related to technical data management and concurrency , existing publications can be developed / converted to S 1000 D standard
A decision to develop / convert the publication in S 1000D standard would make the optimum reusability of publications
As Manufacturers , scientists and designers involved in the design are indispensable for implementing the S 1000D program it will also facilitate the development of publications with accurate data and also will ensure optimum reusability of available Data Modules
All Publications can be developed / converted in to S 1000 D standard in order to overcome the limitations of the existing standards that are in use and of course to enhance the utilization of interactive Electronic Technical Publications for meeting the latest industry standards.
