Implementing S1000D in the Real World

Implementing S1000D: DocTrain East 2007

www.stilo.com

Copyright © Stilo International plc 2007

Implementing S1000Din the Real World DocTrain East 2007

Joe Gollner 17 October [email protected]

Implementing S1000DHistory

Where did S1000D come from?What problem is it trying to solve?

Overview of S1000DStructure of the SpecificationCore ConceptsSchema ArchitectureResources

Implementing S1000DStrategies & FrameworksPractical Role of DITA


www.stilo.com

Historical Background to S1000DS1000D 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

1940 1960 1980 2000

Connecting Knowledge Organizations


www.stilo.com

Proprietary Formats Pose Serious ChallengesLimiting the Interchangeability of all data types

CALS – Tackling the Interchange ProblemGOAL

Supplier and Client

STDS

INTERIM SOLUTION

Supplier ClientSupplier

PROBLEM

Client

1940 1960 1980 2000


www.stilo.com

Standard Generalized Markup Language

1940 1960 1980 2000

The World Wide Web

1940 1960 1980 2000

“Connecting globally dispersed teams”


www.stilo.com

1940 1960 1980 2000

Extensible Markup Language (XML)

Source: Microsoft

The Roots of S1000D

1940 1960 1980 2000

3.01.9

Interactive Electronic TechnicalManual Interoperability

DOD / NATOCALS Standards

Product Life Cycle Support

SGML

Sharable eLearning Objects


www.stilo.com

S1000D History1995

Change 1.6 releasedDescriptive/Procedural – Marked Sections

1998Change 1.7 released

DescriptiveProceduralFaultIPD (Illustrated Parts Catalogue)Schedules (Maintenance Planning)Crew

2000NATO ITD (Interactive Technical Data) Working Group

2001NATO ITD RoadmapInternational Collaboration Accelerates

AIA – ASD (AECMA) – US DoD tri-Service – European DoDs/MoDsstart to co-operate on further developing S1000D from Change 8 to Issue 2.0 and onwards

Emergence as European AerospaceStandard 1984 - 1994

Contributors and Stakeholders2003

ASD (AECMA) & AIA sign Memorandum of Understanding (MOU)Scope of S1000D to non-Aerospace equipmentIssue 2.0 released

2004ASD & DoD ADL (Advanced Distributed Learning) sign MOU

Integration of Training Material into the scope of S1000DIssue 2.1 released

2005Issue 2.2 released ASD & ATA sign MOU at Paris Airshow

2007Issue 2.3 released

Increasing accommodation of requirements from ADL & ATAIssue 3.0 releasedASD / AIA / ATA sign Collaboration Agreement (August 2007)


www.stilo.com

2004-05

Release of Change 2.1-2.2

May 2003

Circulation of Issue 2

S1000D Ch9

CPFCPF

CPF S1000DIssue 2

Restructuring

SeaLand (+GBF)

S1000DChange 2.x

SGML

Air

MIL-PRF-87268

MIL-PRF-87269

Interactivity 1(Process DM)

Interactivity 2

Oct 2003

Release of Issue 2

XML Schema

Emergence of the Current S1000D

MIL-HBK-511

XML

S1000D Evolutionary Path

May 2003

Circulation of Issue 2.0

S1000DIssue 2

Oct 2003

Release of Issue 2.0

S1000DChange 2.1

Cleaning

Feb 2004

Release of Change 2.1

S1000DChange 2.2

2005


New features

2007


S1000DChange 2.3

Major change


www.stilo.com

5.0S1000DIssue 4.0

Q2 2008


Major changeUS Army CPFs

ATA CPFsOther CPFs

Schema cleanupRewrite chapters

Spec in S1000D XMLS1000D/SCORM

S1000DIssue 3.0

2007-07-30


New features<Applic>

Boeing 787Wiring enhanceSchema cleanup

S1000D Evolutionary Path

2007-02-28

Issue 2.3

2007-03-12

Publish 2.3

S1000DChange 2.3

S1000D – Modernizing Equipment Information Purpose

S1000D is an international specification for the procurement and production of technical publications

Key GoalsCost saving on information generation

Avoidance of duplicationsCheaper deliverable publicationsStandard format for data exchangeto exploit future developmentsEnhanced inter-operability

2.3

1.7

3.0

1.8

2.12.0

1.9

2.2

…4.0


www.stilo.com

The Context of S1000DTechnical 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 ScopeFacilitate 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 greatThe breadth of scope alone poses the substantial challenge of incorporating an almost infinite array of application-specific demands

S1000D and Information InterchangeS1000D is primarily an Information Interchange Standard

S1000D addresses the entire content lifecycleThe interchange event stands as the most important

The responsibility for lifecycle processes passes between entitiesS1000D must provide all of the details needed to make interchange successfulDuring the interchange event, details that may be embedded in internal processes or technology components must be expressed in an independent formThe global scope of S1000D absolutely depends on its effectiveness as an interchange standard

S1000D also addresses Process and DeploymentThis breadth of scope explains its “magnitude” and “rate of change”


www.stilo.com

Air Systems• Eurofighter Typhoon• Eurocopter Tiger• HC-2 Chinook• 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

Maritime Systems• Type 45 Destroyer• Astute Class Submarine• Future Carrier

Some Military S1000D Projects

Civilian Deployments S1000D increasing…


www.stilo.com

S1000D is Pursuing a Proven Path

1992 - 2002

The benefits of the equipment-orientation

of reusable content modules proven to be achievable and substantial

on many implementation projects

Ultimate TechDoc – Many Lessons Learned


www.stilo.com

The Real Challenge

Equipment-Oriented Information Model


www.stilo.com

Integrated Content Management & Publishing

Information managed within the context of theEquipment and governing lifecycle processes

Modernization of Content for 20 Main Equipment SystemsInformation refactoring reduced content by between 40% and 60%

Eliminated over 100,000 annual translated change packagesSavings of over $75,000,000 per year

Streamlined change processing with smaller work packagesSavings of over $15,000,000 per year

Reductions in reliance on hard copies by introducing IETMs50% reduction in distributed hard copy change pagesSavings 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

Benefits Realization Review (2003)


www.stilo.com

Applicability to S1000D and DITALessons for S1000D

PositiveEquipment oriented markup and organization of content is keyClose synchronization with logistics & engineering is essential

CautionarySchema architecture should leverage abstractionsSchema architecture should provide extensibility framework

Lessons for DITAPositive

Reuse is key and facilitating reuse is not only a technical issueSchema extensibility is essential for meeting practical needsPublishing process extensibility is important for maintainabilityManaging the complexity for smaller organizations is important

An Overview of S1000D

Structure of the Specification

Core Concepts

Schema Building Blocks

Resources


www.stilo.com

S1000D is a Multi-Part Specification

Issue 3

Chapter 4

Information management

Chapter 1

Introduction

Chapter 2

Documentation process

Chapter 3

Information generation

Chapter 5

Information sets and publications

Chapter 6

Information presentation /

use

Chapter 7

Information processing

Chapter 8

Standard Numbering

System (SNS) and Information

Codes

Chapter 9

Terms and Data Dictionary

Mapping Specification Parts to Pubs Process

Issue 3


www.stilo.com

1.1 Purpose1.2 Scope1.3 How to use this specification1.4 How to tailor for a specific project1.5 Request for change

Issue 3

Chapter 1Introduction

S1000D Chapter 1

S1000D Chapter 2

Chapter 2Documentation process

2.1 Overview2.2 Use of standards 2.3 Relations to other processes and

standards2.4 Implementation Guide2.5 Business Rules Implementation Guide

and more material on Business Ruleswill be provided in the future

Issue 3


www.stilo.com

S1000D Chapter 3

Chapter 3Information Generation

Issue 33.1 Introduction3.2 Data modules3.3 Information sets3.4 Zoning and access3.5 Updating data modules3.6 Security and data restrictions3.7 Quality assurance3.8 Disassembly principles3.9 Authoring

3.9 Authoring is a key reference resource

S1000D Chapter 3: Details

Chapter 3


Authoring and illustrating support

Writing Guidelines Illustrations

MultimediaData Modules- Identification section- Content section- Common constructs- Content section details - Applicability- Attributes

Multimedia 3D

Training

WarningsCautions

Notes


www.stilo.com

Key DefinitionsData ModuleA 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 common source database using the data module code as the identifier.

Common Source DatabaseA "store" 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.

Chapter 3


Data Modules

Chapter 3


One of…

All ofIDSTATUS

CONTENT

Meta data about the

data module

What the user sees

Issue details

DM Address

Security

Applicability

QA Status

Descriptive

Procedural

Fault

CrewParts

Damage

DataModule

Process

Wiring

Schedules

Each DM will have

IDSTATUS metadata

Tech Repository


www.stilo.com

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="005" inwork="00" type="changed"/><issdate year="2007" month="07" day="31"/>

</dmaddres> …</idstatus>

IDSTATUS STATUS Markup Example (1)<idstatus>…<status>

<security class="01" commcls="cc51"/><datarest> <instruct><distrib>To be made available to all S1000D users.</distrib><expcont mark="1" change="modify" rfc="CPF 2006-48AA">

<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

IDSTATUS STATUS Markup Example (2)<idstatus>…<status>…

<rpc rpcname="UK MoD">U8025</rpc><orig origname="UK MoD">U8025</orig><actref> <refdm xlink:type="simple" xlink:actuate="onRequest" xlink:show="replace" xlink:href="URN:S1000D:DMC-S1000DBIKE-AAA-D00-00- 0000-

00AA-00WA-D"><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="1" change="modify" rfc="CPF 2006-47AA"><displaytext>Mountain bicycle and (Mountain storm Mk1 or Brook trekker Mk9)</displaytext><evaluate operator="and"><assert actidref="type" actreftype="prodattr" actvalues="Mountain bicycle"/><evaluate operator="or"><evaluate operator="and"><assert actidref="model" actreftype="prodattr" actvalues="Mountain storm"/><assert actidref="version" actreftype="prodattr" actvalues="Mk1"/></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="simple" xlink:actuate="onRequest" xlink:show="replace" xlink:href="URN:S1000D:DMC-S1000DBIKE-AAA-D00-00-00-00AA-022A-D_005">

<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="005"/> </refdm> </brexref><qa> <firstver type="tabtop"/> </qa><sbc>BY</sbc> <skill skill="sk01"/> <rfu refapplic="app-0001"><p>Bike computer is replaced</p></rfu><remarks>Caption color "blue" is not in the list of S1000D interpreted values. Has been set to "co51".</remarks></status></idstatus>


www.stilo.com

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


Data Module Content Section- 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

Content Procedure Example (1)<content><proced> <prelreqs> <reqconds> <noconds/> </reqconds>

<reqpers> <person man="A"/><perscat category="Basic user"/><trade>Operator</trade><esttime>0,25 h</esttime> </reqpers>

<supequip> <supeqli><supequi id="seq-0001"><nomen>Specialist toolset</nomen><identno>

<mfc>KZ666</mfc><pnr>BSK-TLST-001</pnr></identno><qty uom="EA">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="seq-0002“xidtype="supequip" xlink:actuate="onRequest" xlink:show="replace“xlink:href="seq-0002"/>, from the <xref xrefid="seq-0001“xidtype="supequip" xlink:actuate="onRequest" xlink:show="replace" xlink:href="seq-0001"/>, 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

S1000D Chapter 4

Issue 3

Chapter 4Information Management

4.1 Introduction4.2 CSDB4.3 Data Module (DM) code - DMC4.4 Information Control Number – ICN4.5 DM lists (DML)4.6 Commenting4.7 Version control of DMs4.8 Interchange of DMs4.9 Publication management4.10 Business rules exchange4.11 Process data module4.12 Multiple instances of DMs4.13 Optimizing and Reuse4.14 Applicability

Data Module Code

Data Module Code

Model Id

DataModule

SystemDifference SNS DC DCV IC ICV ILC

Project

Indicates differences in systems

Standard Numbering

System

Indicates disassembly

Same as ALC in LSAR

Indicates type of

information

Indicates variants on type

Indicates location for task

Issue Details

IDSTATUSChapter 3


Data Module AddressChapter 4



www.stilo.com

Identification: A Code for Everything

Chapter 3


Chapter 4


Data Module Codes& Standard Numbering System

Relating Information to Equipment Breakdown

Chapter 3


Chapter 4



www.stilo.com

Publication ModulesPublication Modules

The publication module defines the content and the structure of a publication. It is to contain one or more references to:

data modules (including front matter data modules)access illustration data modulespublication moduleslegacy technical publications

Data Modules Publication Modules

Chapter 3


Chapter 4


Business Rule Exchange (BREX)BREX DM can be used to:

To record and exchange rules while they are being applied in a project. Providing formal descriptions of the business 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 BREXA default BREX is specified

Used to declare rules that apply to the use of elements & attributes available in the specification

Chapter 3


Chapter 4



www.stilo.com

Content BREX Example<content> <brex> <contextrules> <structrules> <objrule><objpath>//dmaddres/dmc/avee/modelic</objpath><objuse>Bike model identification</objuse><objval valtype="single“ val1="S1000DBIKE">S1000D Bike platform</objval><objval valtype="single“ val1="S1000DLIGHTING">S1000D Bike light system</objval> </objrule><objrule><objpath>//dmaddres/dmc/avee/chapnum</objpath><objuse>Systems (Bike specific SNS)</objuse><objval valtype="range" val1="D00" val2="D09"/><objval valtype="range" val1="DA0" val2="DA9"/> </objrule><objrule> <objpath objappl="0">//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="single" val1="at01">Acronym (Candidate for list of abbreviations) -Default value</objval>…</objrule> </contextrules> </structrules>

</brex> </content>

Process Data ModuleThe S1000D process data module represents a procedural flow consisting of several data modules and/or steps that are sequenced.

Decision points (branching), looping, and selective filtering are supported.

Process data module

Process Data module

DM-Alts

DMNodeData

module

Datamodule

DMNode

Datamodule

DMNode

If-DM

DMNode

Datamodule

Datamodule

DMNode

Inherited from the IETM heritage

(MIL-PRF-87268/9)

Chapter 3


Chapter 4



www.stilo.com

ApplicabilityApplicability Cross-reference Table (ACT) data module is the central point of reference for applicability definitions & contains:

mandatory definition of product attributesoptional reference to the Conditions Cross-reference Table (CCT) data moduleoptional reference to the Products Cross-reference Table (PCT) data module

Applicability

Inherited from the IETM heritage

(MIL-PRF-87268/9)

Chapter 3


Chapter 4


Applicability Markup Example<applic> <evaluate operator="or"><assert actreftype="prodattr" actidref="serialno“ actvalues="001~010|012~034" displayclass="ConfirmedAC"/><evaluate operator="and"><assert actreftype="prodattr" actidref="serialno" actvalues="101~118|201~213" displayclass="ConditionalAC"/><evaluate operator="or" displayclass="ConditionStack"><evaluate operator="and" displayclass="techcond"><assert actreftype="prodattr" actidref="serialno" actvalues="101~118"/><assert actreftype="condition" actidref="SB52-1085-FAPE3"actvalues="post" displayclass="sb"/><assert actreftype="condition" actidref="SB54-1086-FAPE3"actvalues="post" displayclass="sb"/></evaluate><evaluate operator="and" displayclass="techcond"><assert actreftype="prodattr" actidref="serialno" actvalues="201~213"/><assert actreftype="condition" actidref="SB52-1085-FAPE3"actvalues="post" displayclass="sb"/></evaluate> </evaluate> </evaluate> </evaluate> </applic>


www.stilo.com

S1000D Chapter 5

Issue 3

Chapter 5Information Sets & Publications5.1 General5.2 Information Sets

- Common Information Sets- Air Specific Information Sets- Land / Sea Specific Information Sets

5.3 Information Sets & Publications

Information setAn “information set“ is the definition of scope and depth of the information required, and is listed in the DMRL (Author’s view).

PublicationA group of DMs sensibly for the end user defined by a publication module (User’s view).

S1000D Chapter 6

Chapter 6Information Presentation / Use

6.1 Introduction6.2 Page-Oriented Publications6.3 Interactive Electronic Technical

Publications (IETPs)- Output specification

6.4 Functionality- Background & explanation- Functionality Matrix- Acquisition management

(forthcoming)

Issue 3


www.stilo.com

Delivering Information

IETPA non-linear presentation of the data module in an user-interactive manner

Page-oriented publicationA linear presentation of the data modules either on paper or screen

Chapter 6

Information Presentation

/ Use

A functionality matrix and acquisition framework has replacedefforts to specify the definitive IETP

S1000D Chapter 7

Chapter 7Information Processing

Issue 37.1 Introduction7.2 Basic concepts7.3 CSDB objects7.4 Generation of publications7.5 Information interchange7.6 Software requirements7.7 Guidance and examples7.8 Applicability

Includes history of changes made to

information schemasProvides background

on schemas definitions


www.stilo.com

S1000D Chapter 8

Issue 3

8.1 General8.2 Maintained SNS8.3 Example SNS

- Series of examples for different system types

8.4 Information Codes

Information codesdeclare the type of information (e.g., Servicing)

Chapter 8Standard Numbering System (SNS)

& Information Codes

9.1 Introduction9.2 Glossary of Terms9.3 Data Dictionary

Issue 3

Chapter 9Terms & Data Dictionary

S1000D Chapter 9

Data dictionary is a reference to an external resource which is an export of schema details from XMLSpy.


www.stilo.com

S1000D ResourcesS1000D 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 SchemaRenditions generated from Master XML Schema

XML Flat SchemaXML DTDsSGML 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

Strategiesfor addressing the challenges

Reality Check


www.stilo.com

Implementation Challenges with S1000DThe First Challenge: Refining the Requirements

Tailoring S1000D to Project RequirementsDefining the governing Business Rules

The Second Challenge: Technology SelectionEstablishing the tools and procedures for creating, managing, publishing and exchanging content

The Third Challenge: Migrating to a New Way of WorkingMitigating the impact on authors and production staffProviding the training, tools and support needed to be successful

The Fourth Challenge: Managing ChangeManaging changes in requirements, equipment source data, partners, the standard itself…

More on ChallengesThe Overview of S1000D should make some things clear:

S1000D is more than a markup schemeS1000D encompasses a wide range of considerations

Needed in order to efficiently manage information that exhibits:Large volumesA significant number of information typesContinuous changeHighly complex structures

Often difficult to create & processAspects that demand absolute precisionAssociation with long-standing methods for addressing equipment information

Implementing S1000D is a significant project in itselfIt is not something that can be done partiallyIt can be exceedingly expensive to implement


www.stilo.com

Implementation ChoicesMany 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 OneOne 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

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 handleunique equipment requirements

Adaptations can be made to handlelegacy or parallel requirements thatare not addressed in S1000D (nor should be)

Application architecture can be streamlined while also improving theprecision & value of the content

S1000D and DITANot S1000D versus DITA

Nor is it S1000 or DITA

SimilaritiesBoth S1000D and DITA embody a modular approach to creating, managing and reusing content

DifferencesS1000D evolved within a standards community made up of a broad range of participants (a community that is getting bigger)

Interchange inevitably becomes a key concernDITA 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

DITA and the Extensibility FrameworkSpecialization is what makes DITA different

Information TypesDomainsMapsApplications

The extensibility framework enables high levels of:Application robustness and reusabilityContent interchangeabilityOverall solution maintainabilitySolution adaptability in the face of evolving requirementsResponsiveness to the realities of authoring

These are very important benefits & S1000D needs them

The Tao of DITA: Specialization


www.stilo.com

DITA & Advanced Aerospace Solutions

Implementation ConceptKey Points

Hybrid data supportCan be deployed to support a complete solutionPotential to maximize use of mainstream productsSuited to a progressive implementation of S1000D


www.stilo.com

Selecting TechnologiesThe First Step

Survey the requirementsIdentify the range of services that will be neededFormalize solutionrequirements

A Word of CautionHighly specialized standards give rise to hyper-specialized productsThese can help but they can also pose problems

The Landscape of Essential Services


www.stilo.com

Technology SelectionKey Considerations

Solution contextScored against requirementsScoring scale

0 – No Fit6 – Total Fit

Results weighedagainst acquisition cost

Technology Lifecycle ConsiderationsSolution context includes

UrgencyComplexityCriticalityConstraints

Projected lifecycleExpected lifespanRate of changeInfluencing factors


www.stilo.com

Facets of a Scalable Solution Architecture

Top Ten List – Secrets of SuccessDon’t underestimate your content or your businessDon’t underestimate the power of good automationChose an appropriate tool set and validate your choicesDon’t invest in expensive technology too earlyCarefully plan and execute migration activitiesTake a “customer service” focus in delivering tangiblebenefits (new products / services) from your investmentsBe demanding of your suppliers (expect quality)Engage your stakeholders and “take control” of the solutionLeverage standards, don’t be enslaved by themBe an active part of the community as a way to learn and as a way to share what you have learned


www.stilo.com

Evaluating Standards: What Really Matters?Independence

From parochial interests, proprietary claims, external influences

FormalityOf creation, validation, approval & modification process

StabilityOf standard over time & the backward compatibility of changes

CompletenessSufficiency for declared scope as well as availability of useful documentation & reference implementations

AdoptionExtent of support amongst tool vendors, authorities & users

PracticalityThe extent to which all, or parts, of the standard can be deployed

Evaluating S1000DScenario

Industry specificationVery broad scopeSpecialized stakeholder communityContinuouslyemergent

StrategyImplement where necessaryAddress challengesand risks


www.stilo.com

The Answers are not Necessarily EasyBut there areanswers…

Where S1000Dis involved, among the answers will be time &money

…in significant quantities

Implementing S1000D in the Real World

Technology

Transcript of Implementing S1000D in the Real World