Presented at DocTrain East 2007 by Joe Gollner, Stilo International -- This workshop will introduce participants to S1000D, a rapidly evolving standard that has gained growing level of adoption as a shared approach to addressing the wide range of requirements associated with planning, creating, managing, publishing and exchanging documentation for complex equipment systems. The workshop will provide guidelines for assessing the applicability of S1000D and an implementation framework for managing S1000D deployments. The following topics will receive specific attention:
* An overview of S1000D, its purpose and history
* A review of the S1000D schema framework
* A closer look at specific models
* The underlying identification and management schemes
* Recent changes and future directions
* Implementation examples
* Criteria for determining if S1000D is right for you
* Key considerations to keep in mind when implementing S1000D
* Comparing S1000D with other standards (e.g., DITA)
2. Implementing S1000D: DocTrain East 2007
Historical Background to S1000D
S1000D arose to fill an
important need
Managing technical
information for complex
equipment systems
Not the first attempt
Offspring of many
previous (and ongoing)
attempts to address
this challenge
The Wayback Machine: The Internet
Connecting Knowledge Organizations
1940 1960 1980 2000
www.stilo.com
3. Implementing S1000D: DocTrain East 2007
Proprietary Formats Pose Serious Challenges
Limiting the Interchangeability of all data types
CALS – Tackling the Interchange Problem
PROBLEM INTERIM SOLUTION GOAL
STDS
Supplier Client Supplier Client Supplier and Client
1940 1960 1980 2000
www.stilo.com
4. Implementing S1000D: DocTrain East 2007
Standard Generalized Markup Language
1940 1960 1980 2000
The World Wide Web
“Connecting globally dispersed teams”
1940 1960 1980 2000
www.stilo.com
5. Implementing S1000D: DocTrain East 2007
Extensible Markup Language (XML)
Source: Microsoft
1940 1960 1980 2000
The Roots of S1000D
DOD / NATO
CALS Standards
Product Life
Cycle Support
SGML
1.9 3.0
Interactive Electronic Technical
Manual Interoperability Sharable eLearning Objects
1940 1960 1980 2000
www.stilo.com
6. Implementing S1000D: DocTrain East 2007
S1000D History
1995
Change 1.6 released
Descriptive/Procedural – Marked Sections
1998
Change 1.7 released
Descriptive
Procedural
Fault
IPD (Illustrated Parts Catalogue)
Schedules (Maintenance Planning)
Crew
Emergence as European Aerospace
2000 Standard 1984 - 1994
NATO ITD (Interactive Technical Data) Working Group
2001
NATO ITD Roadmap
International Collaboration Accelerates
AIA – ASD (AECMA) – US DoD tri-Service – European DoDs/MoDs
start to co-operate on further developing S1000D
from Change 8 to Issue 2.0 and onwards
Contributors and Stakeholders
2003
ASD (AECMA) & AIA sign Memorandum of Understanding (MOU)
Scope of S1000D to non-Aerospace equipment
Issue 2.0 released
2004
ASD & DoD ADL (Advanced Distributed Learning) sign MOU
Integration of Training Material into the scope of S1000D
Issue 2.1 released
2005
Issue 2.2 released
ASD & ATA sign MOU at Paris Airshow
2007
Issue 2.3 released
Increasing accommodation of requirements from ADL & ATA
Issue 3.0 released
ASD / AIA / ATA sign Collaboration Agreement (August 2007)
www.stilo.com
7. Implementing S1000D: DocTrain East 2007
Emergence of the Current S1000D
CPF
MIL-PRF-87268 CPF
CPF S1000D S1000D
MIL-PRF-87269
Issue 2 Change 2.x
S1000D Ch9
MIL-HBK-511 Restructuring
XML Schema SGML
Sea
Interactivity 2
Land (+GBF)
Air
XML
Interactivity 1
(Process DM)
Circulation Release of Release of
of Issue 2 Issue 2 Change 2.1-2.2
May 2003 Oct 2003 2004-05
S1000D Evolutionary Path
S1000D S1000D S1000D S1000D
Issue 2 Change 2.1 Change 2.2 Change 2.3
Cleaning New features Major change
Circulation Release of Release of Release of Release of
of Issue 2.0 Issue 2.0 Change 2.1 Change 2.2 Change 2.3
May 2003 Oct 2003 Feb 2004 2005 2007
www.stilo.com
8. Implementing S1000D: DocTrain East 2007
S1000D Evolutionary Path
S1000D S1000D S1000D
5.0
Change 2.3 Issue 3.0 Issue 4.0
Major change
New features US Army CPFs
<Applic> ATA CPFs
Boeing 787 Other CPFs
Wiring enhance Schema cleanup
Schema cleanup Rewrite chapters
Spec in S1000D XML
S1000D/SCORM
Issue 2.3 Publish 2.3 Release of Release of
Issue 3.0 Issue 4.0
2007-02-28 2007-03-12 2007-07-30 Q2 2008
S1000D – Modernizing Equipment Information
Purpose
S1000D is an international specification
for the procurement and production
of technical publications
2.3 3.0 …4.0
Key Goals
Cost saving on information generation
Avoidance of duplications
Cheaper deliverable publications 2.0 2.1 2.2
Standard format for data exchange
to exploit future developments
Enhanced inter-operability
1.7 1.8 1.9
www.stilo.com
9. Implementing S1000D: DocTrain East 2007
The Context of S1000D
Technical Scope
Provide a global standard for the encoding, storage, exchange and
delivery of the technical information required to produce, operate and
support complex equipment systems
Business Scope
Facilitate the effective digitization and streamlining of the information
supply chains associated with equipments systems that are being
increasingly developed through multi-lateral efforts
Both the benefits and the challenges are great
The breadth of scope alone poses the substantial challenge of
incorporating an almost infinite array of application-specific demands
S1000D and Information Interchange
S1000D is primarily an Information Interchange Standard
S1000D addresses the entire content lifecycle
The interchange event stands as the most important
The responsibility for lifecycle processes passes between entities
S1000D must provide all of the details needed to make
interchange successful
During the interchange event, details that may be embedded in
internal processes or technology components must be expressed
in an independent form
The global scope of S1000D absolutely depends on its
effectiveness as an interchange standard
S1000D also addresses Process and Deployment
This breadth of scope explains its “magnitude” and “rate of change”
www.stilo.com
10. Implementing S1000D: DocTrain East 2007
Some Military S1000D Projects
Air Systems Maritime Systems
• Eurofighter Typhoon • Type 45 Destroyer
• Eurocopter Tiger
• Astute Class Submarine
• HC-2 Chinook
• Future Carrier
• EH-101 Merlin
• F117 Stealth Night Hawk
• RQ-4 Global Hawk
• F-35 Joint Strike Fighter
• Canadian Maritime Helicopter
Land Systems
• Boxer Multi-Role Armoured Vehicle
• FCLV - Future Command and Liaison Vehicle
Civilian Deployments S1000D increasing…
www.stilo.com
11. Implementing S1000D: DocTrain East 2007
S1000D is Pursuing a Proven Path
The benefits of the
equipment-orientation
of reusable content modules
proven to be achievable and substantial
on many implementation projects
1992 - 2002
Ultimate TechDoc – Many Lessons Learned
www.stilo.com
13. Implementing S1000D: DocTrain East 2007
Integrated Content Management & Publishing
Information managed within the context of the
Equipment and governing lifecycle processes
Benefits Realization Review (2003)
Modernization of Content for 20 Main Equipment Systems
Information refactoring reduced content by between 40% and 60%
Eliminated over 100,000 annual translated change packages
Savings of over $75,000,000 per year
Streamlined change processing with smaller work packages
Savings of over $15,000,000 per year
Reductions in reliance on hard copies by introducing IETMs
50% reduction in distributed hard copy change pages
Savings of over $10,000,000 per year (printing & handling)
Additional savings and benefits (harder to quantify but important)
Improved equipment availability, fewer maintenance errors,
better maintainer time utilization, reduction in false replacements,
enhanced information quality, dramatically shortened change
dissemination time
www.stilo.com
14. Implementing S1000D: DocTrain East 2007
Applicability to S1000D and DITA
Lessons for S1000D
Positive
Equipment oriented markup and organization of content is key
Close synchronization with logistics & engineering is essential
Cautionary
Schema architecture should leverage abstractions
Schema architecture should provide extensibility framework
Lessons for DITA
Positive
Reuse is key and facilitating reuse is not only a technical issue
Schema extensibility is essential for meeting practical needs
Publishing process extensibility is important for maintainability
Managing the complexity for smaller organizations is important
An Overview of S1000D
Structure of the Specification
Core Concepts
Schema Building Blocks
Resources
www.stilo.com
15. Implementing S1000D: DocTrain East 2007
S1000D is a Multi-Part Specification
Chapter 1 Chapter 4 Chapter 7
Introduction Information Information
management processing
Chapter 8
Chapter 2 Chapter 5
Standard
Documentation Information sets
Numbering
process and publications
System (SNS)
Issue 3 and Information
Codes
Chapter 3 Chapter 6
Chapter 9
Information Information
generation presentation / Terms and
use Data Dictionary
Mapping Specification Parts to Pubs Process
Issue 3
www.stilo.com
16. Implementing S1000D: DocTrain East 2007
S1000D Chapter 1
Chapter 1
Introduction
Issue 3
1.1 Purpose
1.2 Scope
1.3 How to use this specification
1.4 How to tailor for a specific project
1.5 Request for change
S1000D Chapter 2
Chapter 2
Documentation process
Issue 3
2.1 Overview
2.2 Use of standards
2.3 Relations to other processes and
standards
2.4 Implementation Guide
2.5 Business Rules Implementation Guide
and more material on
Business Rules
will be provided
in the future
www.stilo.com
17. Implementing S1000D: DocTrain East 2007
S1000D Chapter 3
Chapter 3
Information Generation
Issue 3
3.1 Introduction
3.2 Data modules
3.3 Information sets
3.4 Zoning and access
3.5 Updating data modules
3.6 Security and data restrictions
3.7 Quality assurance
3.8 Disassembly principles
3.9 Authoring
3.9 Authoring is a key
reference resource
S1000D Chapter 3: Details
Authoring and illustrating support
Chapter 3
Information
generation
Writing Guidelines Illustrations
Training
Multimedia
Data Modules
- Identification section
Multimedia 3D - Content section
- Common constructs
- Content section details
Warnings - Applicability
Cautions - Attributes
Notes
www.stilo.com
18. Implementing S1000D: DocTrain East 2007
Key Definitions
Data Module
Chapter 3 A self-contained unit of data for the description, operation,
Information identification of parts or maintenance of the Product and its support
generation
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 common source database using the data
module code as the identifier.
Common Source Database
A quot;storequot; of data modules required to produce technical publications.
Data Module Code (DMC)
A 17 to 37 character alphanumeric code identifying the type
and the applicability of the data in a data module.
Data Modules
Meta data DM Address
Chapter 3 about the Issue details Each DM
Information data module will have
generation Security
IDSTATUS
Applicability metadata
IDSTATUS QA Status
Data All of
Module
Descriptive Parts Crew
CONTENT
Procedural Schedules
Fault Wiring Damage
What the
user sees Tech Repository Process
One of…
www.stilo.com
19. Implementing S1000D: DocTrain East 2007
IDSTATUS DMADDRES Markup Example
<idstatus> <dmaddres> <dmc>
<avee>
<modelic>S1000DBIKE</modelic>
<sdc>AAA</sdc>
<chapnum>D00</chapnum>
<section>0</section>
<subsect>0</subsect>
<subject>00</subject>
<discode>00</discode>
<discodev>AA</discodev>
<incode>131</incode>
<incodev>A</incodev>
<itemloc>A</itemloc>
</avee></dmc>
<dmtitle>
<techname>Mountain bicycle</techname>
<infoname>Normal Operating Procedures</infoname>
</dmtitle>
<issno issno=quot;005quot; inwork=quot;00quot; type=quot;changedquot;/>
<issdate year=quot;2007quot; month=quot;07quot; day=quot;31quot;/>
</dmaddres> …</idstatus>
IDSTATUS STATUS Markup Example (1)
<idstatus>…<status>
<security class=quot;01quot; commcls=quot;cc51quot;/>
<datarest> <instruct>
<distrib>To be made available to all S1000D users.</distrib>
<expcont mark=quot;1quot; change=quot;modifyquot; rfc=quot;CPF 2006-48AAquot;>
<expstatement> <p>Export of this data module to all countries that are the residence of
organizations that are users of S1000D is permitted. Storage of this data module is to
be at the discretion of the organization.</p></expstatement></expcont>
<handling>There are no specific handling instructions for this data module.</handling>
<destruct>Users may destroy this data module in accordance with their own local
procedures.</destruct>
<disclose>There are no dissemination limitations that apply to this data
module.</disclose> </instruct>
<inform><copyright>
<para>TPSMG UK, 2003-2010</para>
<para>Government License - TPSMG 001</para> </copyright>
<polref>TPSMG TOR 001</polref>
<datacond>There are no known conditions that would change the data
restrictions for, or security classification of, this data module.</datacond>
</inform>
</datarest>
…</status></idstatus>
www.stilo.com
20. Implementing S1000D: DocTrain East 2007
IDSTATUS STATUS Markup Example (2)
<idstatus>…<status>…
<rpc rpcname=quot;UK MoDquot;>U8025</rpc><orig origname=quot;UK MoDquot;>U8025</orig>
<actref> <refdm xlink:type=quot;simplequot; xlink:actuate=quot;onRequestquot;
xlink:show=quot;replacequot; xlink:href=quot;URN:S1000D:DMC-S1000DBIKE-AAA-D00-00- 0000-
00AA-00WA-Dquot;>
<avee> <modelic>S1000DBIKE</modelic>
<sdc>AAA</sdc>
<chapnum>D00</chapnum>
<section>0</section>
<subsect>0</subsect>
<subject>00</subject>
<discode>00</discode>
<discodev>AA</discodev>
<incode>00W</incode>
<incodev>A</incodev>
<itemloc>D</itemloc> </avee> </refdm> </actref>
<applic mark=quot;1quot; change=quot;modifyquot; rfc=quot;CPF 2006-47AAquot;>
<displaytext>Mountain bicycle and (Mountain storm Mk1 or Brook trekker Mk9)</displaytext>
<evaluate operator=quot;andquot;><assert actidref=quot;typequot; actreftype=quot;prodattrquot; actvalues=quot;Mountain
bicyclequot;/><evaluate operator=quot;orquot;><evaluate operator=quot;andquot;><assert actidref=quot;modelquot;
actreftype=quot;prodattrquot; actvalues=quot;Mountain stormquot;/><assert actidref=quot;versionquot;
actreftype=quot;prodattrquot; actvalues=quot;Mk1quot;/></evaluate> …</status></idstatus>
IDSTATUS STATUS Markup Example (3)
<idstatus>…<status>…
<techstd> <autandtp><authblk>20010131</authblk><tpbase>Bike book</tpbase>
</autandtp><authex/><notes/></techstd>
<brexref>
<refdm xlink:type=quot;simplequot; xlink:actuate=quot;onRequestquot; xlink:show=quot;replacequot;
xlink:href=quot;URN:S1000D:DMC-S1000DBIKE-AAA-D00-00-00-00AA-022A-D_005quot;>
<avee> <modelic>S1000DBIKE</modelic>
<sdc>AAA</sdc>
<chapnum>D00</chapnum>
<section>0</section>
<subsect>0</subsect>
<subject>00</subject>
<discode>00</discode>
<discodev>AA</discodev>
<incode>022</incode>
<incodev>A</incodev>
<itemloc>D</itemloc> </avee>
<issno issno=quot;005quot;/> </refdm> </brexref>
<qa> <firstver type=quot;tabtopquot;/> </qa>
<sbc>BY</sbc> <skill skill=quot;sk01quot;/> <rfu refapplic=quot;app-0001quot;>
<p>Bike computer is replaced</p></rfu>
<remarks>Caption color quot;bluequot; is not in the list of S1000D interpreted values. Has been
set to quot;co51quot;.</remarks>
</status></idstatus>
www.stilo.com
21. Implementing S1000D: DocTrain East 2007
Addition Data Module Metadata (RDF/DC)
<dmodule>
<rdf:Description>
<dc:title>Tire - Fill with air</dc:title>
<dc:creator>U8025</dc:creator>
<dc:subject>Tire - Fill with air</dc:subject>
<dc:publisher>U8025</dc:publisher>
<dc:contributor>U8025</dc:contributor>
<dc:date>2007-07-31</dc:date>
<dc:type>text</dc:type>
<dc:format>text/xml</dc:format>
<dc:identifier>S1000DBIKE-AAA-DA0-10-20-00AA-215A-A_00400
</dc:identifier>
<dc:language>sx-US</dc:language>
<dc:rights>01_cc51_cv51</dc:rights>
</rdf:Description>
<idstatus>…</idstatus>
S1000D Chapter 3: Content Section
Chapter 3
Information
Data Module Content Section
generation - Descriptive information
- Procedural information
- Fault information
- Maintenance planning information
- Crew / Operator information
- Parts information
- Battle damage assessment & repair information
- Wiring data
- Process data module
- Technical information repository
www.stilo.com
22. Implementing S1000D: DocTrain East 2007
Content Procedure Example (1)
<content>
<proced> <prelreqs> <reqconds> <noconds/> </reqconds>
<reqpers> <person man=quot;Aquot;/>
<perscat category=quot;Basic userquot;/>
<trade>Operator</trade>
<esttime>0,25 h</esttime> </reqpers>
<supequip> <supeqli>
<supequi id=quot;seq-0001quot;>
<nomen>Specialist toolset</nomen>
<identno>
<mfc>KZ666</mfc>
<pnr>BSK-TLST-001</pnr>
</identno>
<qty uom=quot;EAquot;>1</qty> </supequi>
<supplies> <nosupply/> </supplies>
<spares> <nospares/> </spares>
<safety> <nosafety/> </safety>
</prelreqs>… </proced> </content>
Content Procedure Example (2)
<content>
<proced> <mainfunc>
<step1> <para>Ensure bicycle is on the repair stand.</para></step1>
<step1> <para>Locate the deflated tire.</para></step1>
<step1><para>Attach the outlet valve of the <xref xrefid=quot;seq-0002“
xidtype=quot;supequipquot; xlink:actuate=quot;onRequestquot; xlink:show=quot;replace“
xlink:href=quot;seq-0002quot;/>, from the <xref xrefid=quot;seq-0001“
xidtype=quot;supequipquot; xlink:actuate=quot;onRequestquot; xlink:show=quot;replacequot;
xlink:href=quot;seq-0001quot;/>, to the valve of the deflated tire.</para>
</step1>
<step1> <para>Inflate the tire.</para>
<step2> <para>Operate the foot pump to pump air into the
tire.</para> </step2>
<step2> <para>Check tire</para></step2>
</mainfunc>
<closereqs> <reqconds> <noconds/> </reqconds> </closereqs>
</proced> </content>
www.stilo.com
23. Implementing S1000D: DocTrain East 2007
S1000D Chapter 4
Chapter 4
Information Management
4.1 Introduction
Issue 3 4.2 CSDB
4.3 Data Module (DM) code - DMC
4.4 Information Control Number – ICN
4.5 DM lists (DML)
4.6 Commenting
4.7 Version control of DMs
4.8 Interchange of DMs
4.9 Publication management
4.10 Business rules exchange
4.11 Process data module
4.12 Multiple instances of DMs
4.13 Optimizing and Reuse
4.14 Applicability
Data Module Code
IDSTATUS
Chapter 4
Chapter 3
Information
Information
Data Module Address
management
generation
Data
Module
Data Module Code Issue Details
Indicates Indicates
Indicates Indicates location
differences disassembly type of
in systems for task
information
System
Model Id SNS DC DCV IC ICV ILC
Difference
Project Standard Same as Indicates
Numbering ALC in variants
System LSAR on type
www.stilo.com
24. Implementing S1000D: DocTrain East 2007
Identification: A Code for Everything
Data Module Codes
Chapter 4
Chapter 3
& Standard Numbering System
Information
Information
management
generation
Relating Information to Equipment Breakdown
Chapter 4
Chapter 3
Information
Information
management
generation
www.stilo.com
25. Implementing S1000D: DocTrain East 2007
Publication Modules
Publication Modules
Chapter 4
Chapter 3 The publication module defines the content and the
Information
Information
management structure of a publication. It is to contain one or more
generation
references to:
data modules (including front matter data modules)
access illustration data modules
publication modules
legacy technical publications
Data Modules Publication Modules
Business Rule Exchange (BREX)
BREX DM can be used to:
Chapter 4
Chapter 3 To record and exchange rules while they are being applied
Information
Information in a project. Providing formal descriptions of the business
management
generation rules decreases the risk of misinterpretation.
To support a correct interpretation of the CSDB objects.
This is important for security and safety details.
To enable validation of the CSDB objects against agreed
rules, for example applying automated methods.
All DMs must refer to a governing BREX
A default BREX is specified
Used to declare rules that apply to the use of
elements & attributes available in the specification
www.stilo.com
26. Implementing S1000D: DocTrain East 2007
Content BREX Example
<content> <brex> <contextrules> <structrules>
<objrule><objpath>//dmaddres/dmc/avee/modelic</objpath>
<objuse>Bike model identification</objuse>
<objval valtype=quot;single“ val1=quot;S1000DBIKEquot;>S1000D Bike platform</objval>
<objval valtype=quot;single“ val1=quot;S1000DLIGHTINGquot;>S1000D Bike light
system</objval> </objrule>
<objrule><objpath>//dmaddres/dmc/avee/chapnum</objpath>
<objuse>Systems (Bike specific SNS)</objuse>
<objval valtype=quot;rangequot; val1=quot;D00quot; val2=quot;D09quot;/>
<objval valtype=quot;rangequot; val1=quot;DA0quot; val2=quot;DA9quot;/> </objrule>
<objrule>
<objpath objappl=quot;0quot;>//descendant-or-self::seqlist[ancestor-or-
self::descript]</objpath>
<objuse>Sequential (numbered) lists not allowed unless in descriptive data
modules</objuse> </objrule>…
<objrule> <objpath>//acronym/@acrotype</objpath>
<objuse>Type of acronym or abbreviation</objuse>
<objval valtype=quot;singlequot; val1=quot;at01quot;>Acronym (Candidate for list of abbreviations) -
Default value</objval>…</objrule> </contextrules> </structrules>
</brex> </content>
Process Data Module
The S1000D process data module
represents a procedural flow consisting of Process
Chapter 4 several data modules and/or steps that are Data module
Chapter 3
Information sequenced.
Information DMNode
management
generation
Decision points (branching),
looping, and selective
Data
filtering are supported. module
If-DM
Data
module
DMNode
Data DM-Alts
Process module
data module DMNode
DMNode
Data DMNode
module
Inherited from the
IETM heritage Data
(MIL-PRF-87268/9) module
www.stilo.com
27. Implementing S1000D: DocTrain East 2007
Applicability
Applicability Cross-reference Table (ACT) data module is the central
point of reference for applicability definitions & contains:
Chapter 4
Chapter 3 mandatory definition of product attributes
Information
Information
management optional reference to the
generation
Conditions Cross-reference Table (CCT) data module
optional reference to the
Products Cross-reference Table (PCT) data module
Applicability
Inherited from the
IETM heritage
(MIL-PRF-87268/9)
Applicability Markup Example
<applic> <evaluate operator=quot;orquot;>
<assert actreftype=quot;prodattrquot; actidref=quot;serialno“ actvalues=quot;001~010|012~034quot;
displayclass=quot;ConfirmedACquot;/>
<evaluate operator=quot;andquot;>
<assert actreftype=quot;prodattrquot; actidref=quot;serialnoquot; actvalues=quot;101~118|201~213quot;
displayclass=quot;ConditionalACquot;/>
<evaluate operator=quot;orquot; displayclass=quot;ConditionStackquot;>
<evaluate operator=quot;andquot; displayclass=quot;techcondquot;>
<assert actreftype=quot;prodattrquot; actidref=quot;serialnoquot; actvalues=quot;101~118quot;/>
<assert actreftype=quot;conditionquot; actidref=quot;SB52-1085-FAPE3quot;
actvalues=quot;postquot; displayclass=quot;sbquot;/>
<assert actreftype=quot;conditionquot; actidref=quot;SB54-1086-FAPE3quot;
actvalues=quot;postquot; displayclass=quot;sbquot;/>
</evaluate>
<evaluate operator=quot;andquot; displayclass=quot;techcondquot;>
<assert actreftype=quot;prodattrquot; actidref=quot;serialnoquot; actvalues=quot;201~213quot;/>
<assert actreftype=quot;conditionquot; actidref=quot;SB52-1085-FAPE3quot;
actvalues=quot;postquot; displayclass=quot;sbquot;/>
</evaluate> </evaluate> </evaluate> </evaluate> </applic>
www.stilo.com
28. Implementing S1000D: DocTrain East 2007
S1000D Chapter 5
Chapter 5
Information Sets & Publications
5.1 General
Issue 3 5.2 Information Sets
- Common Information Sets
- Air Specific Information Sets
- Land / Sea Specific Information Sets
5.3 Information Sets & Publications
Information set
An “information set“ is the definition
Publication
of scope and depth of the A group of DMs sensibly
information required, and is listed in for the end user defined by
the DMRL (Author’s view). a publication module
(User’s view).
S1000D Chapter 6
Chapter 6
Information Presentation / Use
Issue 3
6.1 Introduction
6.2 Page-Oriented Publications
6.3 Interactive Electronic Technical
Publications (IETPs)
- Output specification
6.4 Functionality
- Background & explanation
- Functionality Matrix
- Acquisition management
(forthcoming)
www.stilo.com
29. Implementing S1000D: DocTrain East 2007
Delivering Information
Chapter 6 IETP
Information A non-linear presentation
Presentation of the data module in an
/ Use
user-interactive manner
A functionality matrix and
acquisition framework has replaced
efforts to specify the definitive IETP
Page-oriented publication
A linear presentation of the
data modules either on paper
or screen
S1000D Chapter 7
Chapter 7
Information Processing
Issue 3
7.1 Introduction
7.2 Basic concepts
7.3 CSDB objects
7.4 Generation of publications
7.5 Information interchange
7.6 Software requirements
7.7 Guidance and examples
7.8 Applicability
Includes history of
Provides background changes made to
on schemas definitions information schemas
www.stilo.com
30. Implementing S1000D: DocTrain East 2007
S1000D Chapter 8
Chapter 8
Standard Numbering System (SNS)
Issue 3
& Information Codes
8.1 General
8.2 Maintained SNS
8.3 Example SNS
- Series of examples for
different system types
8.4 Information Codes
Information codes
declare the type of
information (e.g., Servicing)
S1000D Chapter 9
Chapter 9
Terms & Data Dictionary
Issue 3
9.1 Introduction
9.2 Glossary of Terms
9.3 Data Dictionary
Data dictionary is a reference to
an external resource which is
an export of schema details
from XMLSpy.
www.stilo.com
31. Implementing S1000D: DocTrain East 2007
S1000D Resources
S1000D is comprised of:
The Specification (2593 pages)
Data Dictionary (XMLSpy export)
Not very useful (minimal explanation provided on models)
Collection of Schemas and DTDs
Master XML Schema
Renditions generated from Master XML Schema
XML Flat Schema
XML DTDs
SGML DTDs
Bicycle Sample Instance Collection (XML and SGML)
Limited number of additional resources are available and
available experience is largely confined to a small community
Implementing S1000D
Challenges
associated with S1000D
Strategies
for addressing the challenges
Reality Check
www.stilo.com
32. Implementing S1000D: DocTrain East 2007
Implementation Challenges with S1000D
The First Challenge: Refining the Requirements
Tailoring S1000D to Project Requirements
Defining the governing Business Rules
The Second Challenge: Technology Selection
Establishing the tools and procedures for creating, managing,
publishing and exchanging content
The Third Challenge: Migrating to a New Way of Working
Mitigating the impact on authors and production staff
Providing the training, tools and support needed to be successful
The Fourth Challenge: Managing Change
Managing changes in requirements, equipment source data,
partners, the standard itself…
More on Challenges
The Overview of S1000D should make some things clear:
S1000D is more than a markup scheme
S1000D encompasses a wide range of considerations
Needed in order to efficiently manage information that exhibits:
Large volumes
A significant number of information types
Continuous change
Highly complex structures
Often difficult to create & process
Aspects that demand absolute precision
Association with long-standing methods
for addressing equipment information
Implementing S1000D is a significant project in itself
It is not something that can be done partially
It can be exceedingly expensive to implement
www.stilo.com
33. Implementing S1000D: DocTrain East 2007
Implementation Choices
Many of the challenges identified are not new
Past experiences are available on how to address them
The question that arises is whether there are techniques
that can be leveraged to address these challenges?
More specifically, is there a standard that has made this its
overriding purpose?
The answer to both these questions is “Yes”
DITA can be considered an option for facilitating the
implementation of S1000D
The wording here is very specific: “facilitating the implementation”
Two Standards instead of One
One suggestion has been to
integrate S1000D and DITA
One standard to rule them all
This would be a
dubious undertaking
The two standards embody two different,
but complementary, bodies of knowledge
Within any one solution, many standards will play a role:
S1000D, DITA, ATA, XML, XSLT, XSL FO, WSDL, XML Schema…
www.stilo.com
34. Implementing S1000D: DocTrain East 2007
Using DITA to Implement S1000D?
DITA can be leveraged as a tool
To define and tailor precisely specialized
information types that help authors
produce the required content
Adaptations can be made to handle
unique equipment requirements
Adaptations can be made to handle
legacy or parallel requirements that
are not addressed in S1000D
(nor should be)
Application architecture can be
streamlined while also improving the
precision & value of the content
S1000D and DITA
Not S1000D versus DITA
Nor is it S1000 or DITA
Similarities
Both S1000D and DITA embody a modular approach
to creating, managing and reusing content
Differences
S1000D evolved within a standards community made up of a
broad range of participants (a community that is getting bigger)
Interchange inevitably becomes a key concern
DITA evolved initially within a single large organization
Usability and solution productivity became a key concern
So it really should be S1000D and DITA
www.stilo.com
35. Implementing S1000D: DocTrain East 2007
DITA and the Extensibility Framework
Specialization is what makes DITA different
Information Types
Domains
Maps
Applications
The extensibility framework enables high levels of:
Application robustness and reusability
Content interchangeability
Overall solution maintainability
Solution adaptability in the face of evolving requirements
Responsiveness to the realities of authoring
These are very important benefits & S1000D needs them
The Tao of DITA: Specialization
www.stilo.com
36. Implementing S1000D: DocTrain East 2007
DITA & Advanced Aerospace Solutions
Implementation Concept
Key Points
Hybrid data
support
Can be deployed
to support a
complete solution
Potential to
maximize use of
mainstream
products
Suited to a
progressive
implementation of
S1000D
www.stilo.com
37. Implementing S1000D: DocTrain East 2007
Selecting Technologies
The First Step
Survey the requirements
Identify the range of
services that
will be needed
Formalize solution
requirements
A Word of Caution
Highly specialized
standards give rise to
hyper-specialized
products
These can help but they
can also pose problems
The Landscape of Essential Services
www.stilo.com
38. Implementing S1000D: DocTrain East 2007
Technology Selection
Key Considerations
Solution context
Scored against
requirements
Scoring scale
0 – No Fit
6 – Total Fit
Results weighed
against acquisition cost
Technology Lifecycle Considerations
Solution context
includes
Urgency
Complexity
Criticality
Constraints
Projected lifecycle
Expected lifespan
Rate of change
Influencing factors
www.stilo.com
39. Implementing S1000D: DocTrain East 2007
Facets of a Scalable Solution Architecture
Top Ten List – Secrets of Success
Don’t underestimate your content or your business
Don’t underestimate the power of good automation
Chose an appropriate tool set and validate your choices
Don’t invest in expensive technology too early
Carefully plan and execute migration activities
Take a “customer service” focus in delivering tangible
benefits (new products / services) from your investments
Be demanding of your suppliers (expect quality)
Engage your stakeholders and “take control” of the solution
Leverage standards, don’t be enslaved by them
Be an active part of the community as a way to learn and as
a way to share what you have learned
www.stilo.com
40. Implementing S1000D: DocTrain East 2007
Evaluating Standards: What Really Matters?
Independence
From parochial interests, proprietary claims, external influences
Formality
Of creation, validation, approval & modification process
Stability
Of standard over time & the backward compatibility of changes
Completeness
Sufficiency for declared scope as well as availability of
useful documentation & reference implementations
Adoption
Extent of support amongst tool vendors, authorities & users
Practicality
The extent to which all, or parts, of the standard can be deployed
Evaluating S1000D
Scenario
Industry
specification
Very broad scope
Specialized
stakeholder
community
Continuously
emergent
Strategy
Implement where
necessary
Address challenges
and risks
www.stilo.com
41. Implementing S1000D: DocTrain East 2007
The Answers are not Necessarily Easy
But there are
answers…
Where S1000D
is involved,
among the
answers
will be time &
money
…in significant
quantities
www.stilo.com