AskAnS1000DExpert Tour - Chantilly VA - November...

Ask an S1000D Expert™ TourSmithsonian National Air & Space Museum, Chantilly, VA

Lou IuppaVP Strategic Business Development and SDL S1000D Business Owner

Michael CookS1000D Business Analyst

Michael DavisP i i l B i C lt tPrincipal Business Consultant

Agenda: Ask An S1000D Expert™ Tour

12:00 – 12:30 – Conference Registration, Networking and Lunchand Lunch

12:30 – 13:00 – Introductions and S1000D Specification Overviewp

13:00 – 14:15 – S1000D in Action14:15 – 14:30 – Break, Snack, Networking, , g14:30 – 15:30 – “Extending the use of your S1000D

Structured Content” – David Smith, Lockheed MartinMartin

15:30 – 16:30 – Interactive Q&A/Roundtable

Objectives of this Conference

Overview of the S1000D specificationUnderstanding the basics of the specificationUnderstanding the basics of the specificationUnderstanding the importance of a CSDB (Common

Source Data Base) and the publishing process to ) p g pS1000D

S1000D in ActionSDL LiveContent and SDL Contenta S1000D

Extending content value through interactivity with electronic systemsRoundtable: Ask, Share, LearnEnsure you walk away with the answers to your

questions

Introductions

Lou Iuppa, VP Business DevelopmentVP, Business DevelopmentSDL, Structured Content Technologies

Lou Iuppa is the VP of Business Development for pp pSDL, Structured Content Technologies.

In January 2011, Lou took on the responsibility as SDL’s S1000D Business OwnerBusiness Owner.

He manages strategic business relationships with the US Navy and Northrop Grumman as well as new business within the aerospace, defense and commercial technical publication industries.

Lou has over 20 years of experience associated with publishing and content management technologies within a variety of industries from content management technologies within a variety of industries from the perspective of vendor, end user, and consultant.

Introductions

Mike Cook, S1000D Business AnalystS1000D Business AnalystSDL, Structured Content Technologies

Mike has a 30 year history within the aerospace y y pand defense community and has been working with real world S1000D project needs for the past 6 years.

Mike provided S1000D Information Architecture services for the Mike provided S1000D Information Architecture services for the Boeing 787 Dreamliner documentation system.

His experience includes roles within Boeing Flight Test, test labs, and as an Instructor of Systems Analysis, Structured Analysis, Computer Aided Software Engineering, and Project Planning and Controls.

Mike developed SDL’s S1000D Specification Education Series and Mike developed SDLs S1000D Specification Education Series and created SDL’s BREX Builder application.

Introductions

Mike Davis, Principal Business Analyst and Principal Business Analyst and S1000D SpecialistSDL, Structured Content Technologies

Mike has 20 years of experience with complex computing environments, specializing in databases and XML.

H ’ k d ith XML i it’ i ti f d XML d ithi He’s worked with XML since it’s inception focused on XML used within document production and data exchange.

Mike is a programmer, familiar with most SGML/XML data standards p g , /and has over 15 years serving the aerospace and defense industry.

Mike also plays an important role at SDL as a customer advocate by providing input and guidance to SDL’s S1000D product strategy providing input and guidance to SDLs S1000D product strategy.

Introductions

David Smith, IETM Functional LeadIETM Functional LeadLockheed Martin, Manassas, VA

David Smith has over 27 years of experience in the information y ptechnology industry, including experience in IETM (Interactive Electronic Technical Manual) development, training, instructional design, data modeling, IETM databases, and programming.

David holds an M.S. in Instructional Technology and is currently serving as a Technical Documentation Lead for multiple S1000D projects at Lockheed Martin.

David also serves as the lead of the Viewer task team for the Naval Submarine Warfare Federated Tactical System (SWFTS) S1000D IPT.

SWFTS is comprised of a number of submarine systems including sonar, tactical control, weapons control, imaging, electronic warfare, radio room and torpedoes.

SDL Group

Recognized Leader in Global Information ManagementPublicly traded company with $250m+ annual revenues$Over 2000 employees in 50 offices across 32 countriesAward-winning and profitable

ith l t fi i l t bilitwith long term financial stability 1000+ deployments of enterprise technologies80% of the global translation80% of the global translation supply chain use SDL software

SDL St t d C t t T h l iSDL Structured Content Technologies SDL is a leader in the design, creation, delivery and support of technical data systems in the aerospace and

defense community SDL offers award winning component content management, CSDB, PS and PDF Publishing and

IETM/IETP generation and delivery technologies as well as professional services, including system design, g y g p g y gproject management, implementation planning and execution, XML data and workflow modeling, custom programming and system integration.

A sampling of companies and defense organizations who rely on SDL Technologies are US Navy, US Air Force, Northrop Grumman, Raytheon, Boeing, Gulfstream, Pratt & Whitney, and many more.

S1000D Trends

• Strong desire for Vendor Neutrality

• Opportunity for Cost Savings • Significant budgetary pressure to reduce sustainment costs

Business reduce sustainment costs

• Government Data Acquisition Strategy: S1000D deliverables more frequently mandated in contracts

Drivers

• Multi-format, multi-device delivery ready

• Configuration Management• Interactive Electronic Technical Manuals (IETM’s)

• Proven interoperability between d l ti

Technical Drivers vendor solutionsDrivers

V St A ti St d d• Very Strong, Active Standards Community

• Government Spending is Down!

• Technical data management services becoming more competitive

• Tools are readily available to

Market Drivers

achieve the benefits of S1000D

Next Generation Content Delivery Platform

NAVSEA Viewer 1.0

Saab Aerotech – Gripen 39 IETP

S1000D OverviewS1000D Overview

Mike Cook, S1000D Business Analyst

S1000D Overview Slides

S1000D basicsHiHistoryTerminologyImplementation ProcessSupport filesBenefits

S1000D History

The S1000D specification is used to produce technical publications. It is co-owned by the following groups:

European Association of Aerospace Industries (ASD) Aerospace Industries Association (AIA)

Ai T t A i ti (ATA) Air Transport Association (ATA)

The S1000D specification is available from: www.S1000D.org

An outgrowth of the ATA 100 and ATA iSpec 2200

Anyone with experience in ATA 100 or ATA iSpec 2200 has someAnyone with experience in ATA 100 or ATA iSpec 2200 has some degree of familiarity with S1000D

S1000D supports air, land, or sea systems – and can be adapted to pp , , y psupport others. It can support any product requiring publications for maintenance, operation, and configuration of parts and supplies.

History - Why was S1000D created?

European Issues (ASD)• No standard existed to support more than the aviation industry• ATA 100 and ATA iSpec 2200 are considered to be a good start,

but do not incorporate many capabilities needed for other product or industry types

• Partners and customers have different requirements languages• Partners and customers have different requirements, languages, and viewing technologies – no single standard supports all these needs

US DoD Issues (AIA)US DoD Issues (AIA)• Too many different specifications across the services• Millions spent every year on publication maintenance or

conversion to support updates to each of the various standardsconversion to support updates to each of the various standards• Interoperability and data exchange is problematic between the

services and partners – no common method• Data re-use is inconsistent or impossible between publications (noData re use is inconsistent or impossible between publications (no

prescribed recycle paradigm)

History - Why was S1000D created?

Civil Platform Support Issues (ATA)• Aircraft manufacturers and airline customers may not be using the

same documentation standards. When aircraft manufacturers provide maintenance data to customers it must be transformed into whatever specification the customer is using.

• Aircraft manufacturers and customers want to move from Document Centric Publications to Information Centric Publications

• Data re-use is becoming more important as new technology influences how new products are maintained and how the information to support these activities is presented to technicians

• Aircraft manufacturers and customers want to exchange data gusing a formal supported format

S1000D Terminology – Abbreviations

DMC – Data Module CodePMC – Publication Module CodeICN – Information Control NumberDMRL – Data Module Requirements ListCSL – CSDB Status ListCSL – CSDB Status ListDDN – Data Dispatch NoteSNS – Standard Numbering System DC – Disassembly CodeIC – Information Code (aka infocode)CSDB Common Source Data BaseCSDB – Common Source Data Base BREX DM – Business Rules Exchange Data ModuleLOAP – List Of Applicable PublicationsLOEDM – List Of Effective Data ModulesIETP – Integrated Electronic Technical Publication

S1000D Terminology – Data Modules

The smallest self contained information unit within a technical publication. The equivalent of a “topic” or the most granular piece of information about a task or descriptive “How to” of a system.Data modules are created using “schemas” Schemas are used asData modules are created using schemas . Schemas are used as the framework for an “information set”. The various core schemas are:

• Procedural – proced.xsdD i ti d i t d

Data module file<dmodule>• Descriptive - descript.xsd

• Process – process.xsd• Crew – crew.xsd• Fault Isolation – fault.xsd• Illustrated Parts Data – ipd.xsd

Metadata about the data module’s content<identAndStatusSection>

Content – procedure, process, Illustrated Parts Data ipd.xsd• Schedule – schedul.xsd (yes the “e” is missing on purpose)• Technical Information Repository – techrep.xsd• Wiring Data - wrngdata.xsd• Container – container.xsd

p , p ,how to, etc - all based on the information code and schema of the data module<content>

• Learning – learning.xsd• Checklist – checklist.xsd• Business Rules – BREX – brex.xsd• Publication Module – pm.xsd• Applicability Cross reference Table appliccrossreftable xsd• Applicability Cross-reference Table - appliccrossreftable.xsd• Product Cross-reference Table – prdcrossreftable.xsd• Conditions Cross-reference Table – condcrossreftable.xsd• SCORM Content Package – scormcontentpackage.xsd

S1000D Implementation Process

Adopting S1000D usually consists of the following pieces• Make Business Rule decisions - identifying how various features

of the specification will be used for the given project• Create or flesh out a Standard Numbering System (SNS)• Add information code variants (if needed)Add information code variants (if needed)• Create a Data Module Requirements List (DMRL) (optional)• Implement a Content Management System - referred to as a

Common Source Data Base (CSDB)Common Source Data Base (CSDB)• Author content - using XML, graphics, and multimedia• Assemble Publication Modules• Publish – digital distribution or paper

• Publishing for digital distribution may include selecting an Interactive Electronic Technical Publication (IETP) viewer, creation of a website, or hosting an FTP site for distribution of raw XML data modules directly to customerssite for distribution of raw XML data modules directly to customers

S1000D Support file - DMRL

Data Module Requirements List Used to define and create the data modules for the Product (optional) Data modules are usually defined by the SMEs and authors and can be inserted

into a DMRL. The DMRL can be used to create skeleton XML files.

CSDB Empty Data ModulesDMRL file

DMRL can produce

S1000D Support file – Publication Module

CSDB - Project D t M d l

Publication Module Aircraft Maintenance

Manual (AMM) Data ModulesManual (AMM)

Publication Module Publication Module System Description

Section (SDS)

Crew door latch – Description of functionDMC-PROD1-A-52-11-05-00A-042A-A

=

System Description SectionPMC-PROD1-AAAAA-04001-01

=

S1000D Support file – Data Dispatch Note

S1000D provides a method to transfer data modules using a data interchange method – also known as a transfer package The transfer package must have a Data Dispatch Note (DDN) and at least one data module. Other S1000D files can also be included, for example: Illustrations and multimedia files Publication Modules a CSDB Status List (CSL)( )

CSDB files (DMC, ICN, etc) Transfer Package

Export CSDB content (files)

Benefits

S1000D enables collaboration of content, interchange of files, and content reuse Collaboration:

• Contracts are generally written to indicate the use of a specific issue of the specificationA D t M d l R i t Li t (DMRL) ll d t d l t b d fi d• A Data Module Requirements List (DMRL) allows data modules to be defined before authoring occurs. This is part of the business rules decision making process and allows multiple manufacturers to participate in the definition process

• Data Dispatch Note (DDN) files are used as part of the file transfer process to help create transfer packages (also known as revision packages). Content migrated from the CSDB for delivery to partner companies and for delivery to digital only recipients uses a simple method which is easily implemented.

• If S1000D is used by multiple organizations, the data created in each CSDB can be imported and exported between partners with relative ease

Content Reuse:• Content is authored at the data module level and is referenced by publication

modules. Reusing the data module in another publication is as easy as creating a reference to the data module within the publication module.

S1000D in ActionS1000D in Action

Mike Davis, Principal Business Analyst and S1000D Specialist

What we’re going to demonstrate

Deliver Electronically

PublishManage and Automate

Author

Publishing Output

Type 2 Interactive Electronic Technical Manuals

LiveContent P bli hi

CCM/CSDB

LiveContent

Publishing Server

XML Professional

Publisher

Contenta S1000D

ORACLE

Editorial W kfl

Check in/outXML DB

ArbortextWorkflow

Type 1 Paper/PDF Technical Manuals

Data Module(s)

XSL-FO

Arbortext Editor

Mr. David Smith, IETM Functional LeadLockheed Martin

SWFTS Program

Extending the Use of Your S1000D St t d C t tStructured Content

Click Here to LaunchClick Here to Launch

Extending the use of your S1000D structured content

David SmithLockheed Martin‐MS29500 Godwin DriveManassas, VA 20110

(703) 367‐4847

Copyright 2011 (Unpublished) Lockheed Martin Corporation. All Rights Reserved.

BackgroundBackground

• My Background and Experiencey g p– Experience with multiple S1000D products– IETM (Interactive Electronic Technical Manual), aka IETP (Interactive Electronic Technical Publication) forIETP (Interactive Electronic Technical Publication) for many international projects

– Electronic systemsf l l k f l ff h h lf• Systems of multiple racks of Commercial‐Off‐The‐Shelf

(COTS) hardware , and• Also includes documentation of software displays (GUI) and procedures to operate the systemprocedures to operate the system

– Organizational level (O‐level) maintenance concepts• Documentation for end users to for basic operation and maintenancemaintenance


IntroductionIntroduction

• Extensibilityy– XML: repository of organized, self–describing data– Extending S1000D

H I d h f h i l d ? [ i ]• How can I extend the use of my technical data? [requirements]• How do I structure my data do accomplish this? [plan]

• The “product” (as S1000D spec refers to it) is the item(s) being documented in the technical publication– A specific piece of equipment (jet engine, weapon, refrigeration unit or computer hardware)refrigeration unit, or computer hardware)

– An entire system including both electronic hardware and software


Integrated IETMsIntegrated IETMs

• For an electronic system the IETM is oftenFor an electronic system, the IETM is often installed and viewed on the “product”

• Provides more opportunities to integrate the• Provides more opportunities to integrate the IETM with the product

Th t d th t l li ti– The system and other external applications can interact with the IETM Viewer which houses the published technical data repositorypublished technical data repository


Brief History of Structured DataBrief History of Structured Data

• Relational Databases– Structured in tables– Record‐basedU d D• Unstructured Data– Text files, word processing documents, HTML– Document‐based but data not always self‐describingDocument based, but data not always self describing

• Semi‐structured Data– SGML, XML documents

• Object‐oriented and XML databases• Hybrid database concepts


Levels of StructureLevels of Structure

• S1000D schema by data module type• Business rules may (and should) define further structure

– Writing standards, conventions, depth of content– Number of paragraphs, levels of indentation (nesting)

f h d f f f– Define a consistent method for constructing specific types of content• Physical descriptions• Functional descriptions• Operating proceduresp g p• Remove/replace procedures• Fault Isolation procedures• Operational Displays (software GUI)

– ID schemes or other attributes– ID schemes or other attributes• What rules are needed and what levels of structure depend on your

project’s requirements


Planning your S1000D ProjectPlanning your S1000D Project• Typical Business Rules based on decision points in the S1000D

specificationspecification:– “….is a project decision.”– “The Project must decide…”

• Define extended requirements for your projectq y p j– Ask questions beyond the typical questions asked

• What external applications need access to the technical data?• How will the system interact with the IETM?• What “chunks” of data need to be accessed or reused?

– Document the functional requirements• Determine how to structure your data to meet the requirements

– Granularity of data modules – size of data moduleI t t d t d l di t t– Impacts to data module coding strategy

• Identification of specific data modules that need to be accessed– Standards for how data will be consistently organized inside data modules

(data module authoring rules)Id if i di i i hi h DM h d b d– Identifying discrete items within the DM that need to be accessed


Accessing the DataAccessing the Data

• Once functional requirements have been qidentified and rules have been established, a methodology is needed to access the data

• How do I retrieve technical data from an IETM• How do I retrieve technical data from an IETM and integrate it with the system or provide data to other external applications?

• Two possible methods using LiveContent– Use copies of data modules from the source_xmlfolderfolder

– Utilize the LiveContent API to provide the data directly from the LiveContent database


Using source xmlUsing source_xml

• Publish source xml folder with your IETMPublish source_xml folder with your IETM

• Access copies of specific XML files (data modules) from the source xml foldermodules) from the source_xml folder

• Disadvantages– Using a copy of the data module

– Duplicate distribution of data modules


Utilizing the LiveContent APIUtilizing the LiveContent API

• The LiveContent API retrieves data directly from e eCo te t et e es data d ect y othe internal database in the LiveContent IETM

• The same location where the LiveContent viewer retrieves the data

• The API provides many different types of API calls providing additional flexibility and capabilities– Examples:

• R t i d t XML HTML• Retrieve data as XML or HTML• Direct the LiveContent viewer to display a specific data module


Utilizing the LiveContent APIUtilizing the LiveContent APIRequest for Data

LiveContentIETM Viewer

Request to display a Data Module

ExternalApplication

IETM Viewer

LiveContentAPI

Data M d l

•System software•Custom viewer•Simulation

Application API Modules•CBT•And ?

Data Module as XMLExternal application can parse returned

Data Module as HTMLparse returned

data


ApplicationsApplications• Utilizing custom multimedia viewers to enrich the interactive experience for the

end userend user– Flash‐based viewer requests data modules [XML] from LiveContent– Parses the data module content and renders it to an external browser window– Can integrate display of content from multiple data modules

• Example: Physical Description and Parts integrated viewerp y p g– Can provide enhanced display of a specific data module type

• Example: Flowchart Viewer for Fault Isolation Data Module

• Request LiveContent to load a specific data module in the viewer– Context sensitive links based on a user selecting an option from a drop down menu in the

fsystem software– Links from a custom viewer

• Request LiveContent to return a specific data module’s contents to the system software as HTML

U k f li h l f ithi d t d l– User can ask for online help from within a data module• Example: What’s This? On‐line help

• Simulation products can request specific data modules to obtain pin‐to‐pin wiring information for cables, ensuring that the data matches the IETM exactly

• Computer based training courseware can request IETM data• Computer‐based training courseware can request IETM data


Applications


ApplicationsFile Edit Control Attributes Help

1 4

HelpIndex…What’s This?About…

User selects What’s This? option1

2

4

5

option

3



1 41

2

4

5

User highlights area or item of interest

3

interest

f


System software sends request to LiveContent API

LiveContentAPI

Data Modules



1 4System software formats and displays 1

2

4

5

Help content about selected area displays in a popup window

3

LiveContent API


System software LiveContent API

Returns data module content

as HTML

LiveContentAPI

Data Modules

software parses returned HTML data


RoundtableRoundtable

Moderator: Lou Iuppa

Panelists: Mike Cook, Mike Davis and YOU!

Webinars, Workshops and Wrap UpWrap Up

Lou Iuppa, VP Business Development

Where can I go from here?

SDL – “Your Source for S1000D Information” SDL S1000D Resources Page (handout) SDL S1000D Resources Page (handout)

• http://www.sdl.com/S1000DResources SDL’s Educational S1000D Recorded Webinars Series/Archive

SDL S1000D S ifi i Ed i S i SDL S1000D Specification Education Series Ask an S1000D Expert™ Tour Upcoming Events – Webinars, Conferences, Tours p g

• http://www.sdl.com/en/xml/events/• Webinar Series: S1000D Applicability Boot Camp

– Part 3: The CCT Data Module – November 9Part 3: The CCT Data Module November 9 On-Site S1000D Workshop

[email protected]

SDL S1000D Online Webinar Recordings

5 Part SeriesPart 1 – S1000D Alphabet Soup: Introduction to S1000D Concepts

Part 2 S1000D Content WorkflowPart 2 – S1000D Content Workflow

Part 3 – S1000D Applicability

Part 4 - S1000D Interactive Electronic Register and View ALL the Recorded

Technical Publications (IETP)

Part 5 - S1000D and Multimedia

ALL the Recorded Events!

http://www.sdl.com/en/xml/resources/resources-by-topic/topic-s1000d.asp

SDL S1000D Specification Education Series

Introduction to S1000D S1000D – An In-Depth Explorationp pAuthoring and Editing for S1000DChange Management (Editing/QA Cycle/Workflow)Front Matter – An Exploration of the PossibilitiesApplicability – An In-Depth Exploration of its Inner WorkingsWorkingsCommon Source Data Base (CSDB) – What It Is, What It Can Do, What You Need to KnowProject Startup for S1000D

Industry Conferences, Groups

Industry Conferences S1000D User Forum S1000D User Forum

• http://www.ataebiz.org/forum

AIA Techpubs Conference, Clearwater, FL – each May

S d U GSpecs and User Groups Download the S1000D Spec – for a little light reading!

• http://public s1000d org/Downloads/Pages/S1000DDownloads aspxhttp://public.s1000d.org/Downloads/Pages/S1000DDownloads.aspx

S1000DPC™ User's Group • http://www.s1000dpc.com/

LinkedIn “S1000D Users” Group LinkedIn – S1000D Users Group

S1000D Workshop

Objectives Gain a high level

understanding of the S1000Dunderstanding of the S1000D specification

Experience the project planning process

Create S1000D content Manage content in a CSDB Publish an interactive

electronic technical manual (IETM)

Lay foundation for business case

Prerequisites Team has XML authoring skillsg Executive sponsor identified,

and available for opening and close of workshop

Wrap Up

Evaluation FormLiteratureLiteratureSurvival ToolBuddiesBuddies

Contact Us!

[email protected]

AskAnS1000DExpert Tour - Chantilly VA - November...

Documents

Transcript of AskAnS1000DExpert Tour - Chantilly VA - November...