Ask an S1000D Expert Tour Warner Robins, GA

Transcription

1 Ask an S1000D Expert Tour Warner Robins, GA Lou Iuppa VP Strategic Business Development and SDL S1000D Business Owner Michael Cook S1000D Business Analyst Michael Davis Principal i Business Consultant t

2 Agenda: Ask An S1000D Expert Tour 12:00 12:30 Conference Registration, Networking and Lunch 12:30 13:30 Introductions and S1000D Specification Overview 13:30 14:30 Michael Davis, Best Practices with Multimedia and Hot Spotting in S1000D 14:30 14:45 Break, Snack, Network 14:45 15:30 S1000D in Action 15:30 16:30 Interactive Q&A/Roundtable

3 Objectives of this Conference Overview of the S1000D specification Understanding the basics of the specification Understanding the importance of a CSDB (Common Source Data Base) and the publishing process to S1000D Explore Best Practices for working with Multimedia and Hot Spotting S1000D in Action SDL LiveContent and SDL Contenta S1000D Roundtable: Ask, Share, Learn Ensure you walk away with the answers to your questions

4 Introductions Lou Iuppa, VP, Business Development SDL, Structured Content Technologies Lou Iuppa is the VP of Business Development for SDL, Structured Content Technologies. In January 2011, Lou took on the responsibility as SDL s S1000D Business 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 the perspective of vendor, end user, and consultant.

5 Introductions Mike Cook, S1000D Business Analyst SDL, Structured Content Technologies Mike has a 30 year history within the aerospace and 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 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 SDL s S1000D Specification Education Series and created SDL s BREX Builder application.

6 Introductions Mike Davis, Principal Business Analyst and S1000D Specialist SDL, Structured Content Technologies Mike has 20 years of experience with complex computing environments, specializing in databases and XML. 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 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.

7 SDL Group Recognized Leader in Global Information Management Publicly traded company with $250m+ annual revenues Over 2000 employees in 50 offices across 32 countries Award-winning and profitable with long term financial i stability deployments of enterprise technologies 80% of the global translation supply chain use SDL software

8 SDL Structured t Content t 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, project 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.

9 S1000D Trends Strong desire for Vendor Neutrality Opportunity for Cost Savings Business Significant budgetary pressure to reduce sustainment costs Government Data Acquisition Drivers Strategy: S1000D deliverables more frequently mandated in contracts Technical Drivers Multi-format, multi-device delivery ready Configuration Management Interactive Electronic Technical Manuals (IETM s) Proven interoperability between vendor solutions Market Drivers Very Strong, Active Standards d Community Government Spending is Down! Technical data management services becoming more competitive Tools are readily available to achieve the benefits of S1000D

10 Next Generation Content Delivery Platform

11 NAVSEA Viewer 1.0

12 Saab Aerotech Gripen 39 IETP

13 S1000D Overview Mike Cook, S1000D Business Analyst

14 S1000D Overview Slides S1000D basics History Terminology Important activities Support files How do you get there? The Larger context Challenges of adoption Best of Breed S1000D Implementations The myth of the end-to-end solution The best of breed solution The CSDB matters Why publishing matters

15 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) Air Transport Association (ATA) The S1000D specification is available from: An outgrowth of the ATA 100 and ATA ispec 2200 Anyone 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 p support others. It can support any product requiring publications for maintenance, operation, and configuration of parts and supplies.

16 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, and viewing technologies no single standard supports all these needs 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 standards Interoperability and data exchange is problematic between the services and partners no common method Data re-use is inconsistent or impossible between publications (no prescribed recycle paradigm)

17 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 g using a formal supported format

18 S1000D Terminology Abbreviations DMC Data Module Code PMC Publication Module Code ICN Information Control Number DMRL Data Module Requirements List CSL CSDB Status List DDN Data Dispatch Note SNS Standard Numbering System DC Disassembly Code IC Information Code (aka infocode) CSDB Common Source Data Base BREX DM Business Rules Exchange Data Module LOAP List Of Applicable Publications LOEDM List Of Effective Data Modules IETP Integrated Electronic Technical Publication

19 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 as the framework for an information set. The various core schemas are: Procedural proced.xsd Descriptive - descript.xsd d Process process.xsd Crew crew.xsd Fault Isolation fault.xsd 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 Learning learning.xsd Checklist checklist.xsd Business Rules BREX brex.xsd Publication Module pm.xsd Applicability Cross-reference reference Table - appliccrossreftable.xsd Product Cross-reference Table prdcrossreftable.xsd Conditions Cross-reference Table condcrossreftable.xsd SCORM Content Package scormcontentpackage.xsd Data module file <dmodule> Metadata about the data module s content <identandstatussection> Content procedure, process, how to, etc - all based on the information code and schema of the data module <content>

20 S1000D Important activities 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) Create a Data Module Requirements List (DMRL) (optional) Implement a Content Management System - referred to as a 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 customers

21 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. DMRL file CSDB Empty Data Modules DMRL can produce

22 S1000D Support file Publication Module Publication Module Aircraft Maintenance Manual (AMM) CSDB - Project Data Modules Publication Module System Description Section (SDS) Crew door latch Description of function = DMC-PROD1-A A-042A-A = System Description Section PMC-PROD1-AAAAA

23 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)

24 The Larger Context 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 specification A Data Module Requirements List (DMRL) allows data modules to be defined d 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.

25 S1000D: How Do You Get There? e Crossing the road to adoption

26 S1000D: Challenges of Adoption What is Needed Details Impediments to success Deep knowledge of the specification Defining the business rules so as to manage changes to the authoring environment Technical know-how Technology infrastructure Knowledge of terminology, understanding of S000D concepts and coding rules Learning to write to the data module paradigm New workflow methods to support authoring, review, editing, and publishing cycle Knowing how to work with XML, publishing basics, and IETP experience Experience with a CMS Authoring Tools CSDB Publishing Engine APIs to Integrate with Other systems (LSAR/Parts/Wiring) Learning curve Psychology of change, new methods, identifying what needs to change in an existing environment Human resources, access to existing information on the spec, etc Flexibility, support, programming/macro language capabilities, compliance to spec File/data exchange Subcontractors, OEMs, and Seamless data exchange between partners between organizations Service organizations must all adopt S1000D

27 Best of Breed S1000D Implementation Product Lifecycle Management Technical Content Development Logistics Management Publishing Client Applications Product information Part data PLM digital content CSDB LSAR IETP Each of these applications represent complex processes and specific expertise. No single vendor has the expertise to do all of it well.

28 Authoring is not Content Management Some vendors try to simplify the requirements around S1000D by focusing on authoring tools Authoring is important, but does not address the major requirements associated with S1000D: DMRL creation DMC and ICN creation and management Publication module creation and management Data interchange using a DDN Multi-channel publishing outputs (PDF, IETP) These tasks are performed by the IT department and generally require intensive i interaction ti with the CSDB Find a good XML Editor for authoring and a good CSDB for the management of S1000D content focus on built-in functionality to handle the major requirements listed above

29 Why Publishing Matters The publications your company creates can be the difference between life and death for users of your products! Publishing your content determines how internal and external customers s use your content t S1000D IETPs should provide state-of-the-art functionality: Run-time applicability filtering Support for CGM, TIFF, SVG, Flash, 3D images, wire tracing, animations, simulations, virtual task training, digital photographs, and more Locator graphics (graphical navigation); Graphic-to-graphic, graphic-to- text, text-to-text, to and text-to-graphic to linking capabilities Customizable skins and styles; open architecture Support for Process Data Modules and links to external applications Revision i highlights hli ht and incremental update functionality Annotations and built-in problem reporting Audit trails and forms capabilities

30 S1000D Best Practices for Deployment Primary Responsibility Months SDL SDL Workshop Implementation ti (out-of-the-box) Workshop System configuration and deployment Style sheets finalized Customer Learn S1000D Adoption, content reuse, and change management Business Rule decisions (document and apply to BREX DM) Client sign off Live Release! IT / Admin Setup and Configure Server Install Configured SDL Server SDL or Consultant S1000D Author Training Content Creation and Conversion IETM Styles

31 Best Practices with Multimedia and Hot Spotting in S1000D Michael Davis, Principal Business Analyst and S1000D Specialist

32 Objectives Hot-Spotting Techniques Graphic to Text Text To Graphic Raster Graphic Right Hemisphere ( 3D ) Locator Graphics using Flash or Right Hemisphere How to Link from the locator graphic directly to a Data Module How to synchronize Live Content TOC after making selection on Locator Graphic XREF Creation Internal xrefs External refs Pub refs

33 Objectives Continued Cover Applicability Creation and Maintenance Data Module Applicability and Content Applicability XML tagging including attributes ACT, CCT, and PCT Files Explanation of ACT, CCT, and PCT work + demonstration New SDLTools for applicability creation System assisted assertion statement building System assisted creation and maintenance of Content Applic Cover Multimedia/Figure Tagging and Attributes 3d Files Light Weight 3d Models Vector Graphics SVG and CGM Animation Right Hemisphere, Flash, MPEG, MP4 Raster Graphics and Raster Image Maps Sound - MP3

34 Hot Spotting Graphic to text linking capabilities for immediate retrieval of part/item information from an illustration Graphic Hotspots link directly to illustrated parts catalog or task/procedure.

35 Hot Spotting Creation of Hotspot Explanation Hotspot id in the graphic Hotspot name in the graphic ID you assign to indentify hot spot Markup <hotspot applicationstructureident="hot000 applicationstructurename="0 hotspottitle="bicycle" hotspottype="callout" id="fig-0001-gra-0001-hot-0000" objectdescr="bicycle" visibility="visible"> </hotspot>

36 Hot Spotting Graphic to Text Explanation Fill in id attribute on elements supported by the following list of elements that support this functionality. For this example we are using internalref Internalref markup inside hotspot points to already id d <para> element Markup <para id="p-0">a bicycle Test</para> <hotspot applicationstructureident="hot000" applicationstructurename="0" t hotspottitle="bicycle" hotspottype="callout" id="fig-0001-gra-0001-hot-0000" objectdescr="bicycle" visibility="visible"> <internalref internalrefid="p-0" internalreftargettype="para" para xlink:actuate="onrequest" xlink:show="replace" xlink:type="simple"></internalref> </hotspot>

37 Hot Spotting Graphic to Text Hot Spots Graphic to Text Graphic to text linking capabilities for retrieval of part/item information from an illustration Allows immediate highlight of graphic callout or graphic object

38 Hot Spotting Text to Graphic Hot Spots Text to graphic Text to graphic linking allows editors to create highlighted g parts or hotspots within a graphic in a simple manner Allows immediate highlight of graphic callout or graphic object

39 Hot Spotting Text to Graphic Explanation Hotspot has been created and the id has been assigned at time of creation Create internalref markup which points back to the hotspot using the hotspot id. Markup <hotspot applicationstructureident="hot000" applicationstructurename="0" hotspottitle="bicycle" hotspottype="callout" id="fig-0001-gra-0001-hot-0000" objectdescr="bicycle" visibility="visible"> </hotspot> t> <internalref internalrefid="fig-0001-gra hot-0009" internalreftargettype="hotspot" xlink:actuate="onrequest" xlink:href="#fig-0001-gra-0001-hot-0009" xlink:show="replace" xlink:type="simple">frame </internalref>

40 Hot Spotting Hot Spots Graphic to Graphic Simple Linking to and from graphic to graphic

41 Hot Spotting Graphic to Graphic Explanation Hotspot has been created and the id has been assigned at time of creation Markup <hotspot applicationstructureident="autoid_7900" applicationstructurename="hottographic" hotspottitle="graphic to Graphic" hotspottype="callout" tt id="gra-001"> Create internalref markup which points back to the figure using the fig id <internalref internalrefid="fig-0005" internalreftargettype="figure" figure targettitle="derailler Pivot"></internalRef> </hotspot>

42 Raster Graphics and Image Maps Provides authors ability to utilize simple images and create hotspots without custom tools Image repository may contain images or photos that were not derived from 3d

43 Raster Graphics and Image Maps <figure> <title>icn-s92-a a a-01-1_en</title> <graphic id="turbine1 infoentityident="icn-s92-a a a-01-1_en"> Object Coordinates are X and Y Placement Positions <hotspot applicationstructureident="h001" hotspottype="callout objectcoordinates="228,60,326,143"> <internalref internalrefid="hot001 internalreftargettype="para"></internalref> </internalref> </hotspot> <hotspot applicationstructureident="h002" hotspottype="callout objectcoordinates="111,157,177,234">,, <internalref internalrefid="hot2 internalreftargettype="other"> </internalref> </hotspot> t </graphic> </figure>

44 Benefits of 3D Graphics in S1000D Deliverables Tells a Better Story Animations, Materials, Metadata, Interactive View any Angle, Render Modes, Cross-Section, Measure Reduces Repair Time & Costs Simplifies complex tasks & processes Easier to understand & comprehend Higher retention of information from interactive 3D content Reduces Localization Costs Better graphical content delivered = less text written & translated! Enables Change Management Allows easy updating of content when changes occur in Engineering Auto updating if connected to original Engineering data source.

45 3D Support with Right Hemisphere Deep View control embedded with LiveContent IETP Viewer Integration between Right Hemisphere Deep View and Live g g p p Content IETP allows Steps to be called out from pub to graphic

46 Right Hemisphere LiveContent/Right Hemisphere Integration allows text exchange between DMC and 3d Graphic Tasks and Procedures Animations driven from within 3d model or IETP Step position

47 3D Support with Right Hemisphere Great For IPD Single graphic can cover entire parts list for IPD

48 Locator Graphic LiveContent Flash Integration provides use of interactive Locator graphics allowing users to easily drill down through a graphic and find the system, procedure, or task

49 Locator Graphic LiveContent example of user Mouse Over Flash API using javascript calls to interact with Table of Contents

50 Locator Graphic LiveContent example of a mouse click on the system or subsystem being researched will display a detail view of that system and opens the TOC (Table of Contents pane on the left) to the appropriate document unit

51 Applicability Creation and Maintenance Applicability is one of the most confusing parts of S1000D Employing it correctly is very difficult Reduction of errors during maintenance due to concise interactive illustrations and multimedia In countries where English is not the primary language technicians can follow intuitive interactive illustrations and rely less upon the written word increasing technician effectiveness Cutting Costs Intelligent Interactive graphics and media objects reduce the amount of technical authoring narrative needed for support of complex tasks and procedures Reduction in narrative text leads to fewer written words increasing author productivity while reducing the cost of localization

52 Applicability in Action Updated Contenta S1000D Arbortext Plug-in with Applicability Assistant Create Applic without having to handcode!! Assert Statement Builder Update ACT, CCT, and PCT tables from Plug-in Access saved applic settings at any time Apply settings from within Editor Real Time Preview of Applic settings.

53 Applicability in Action Modified Menu New Plug-in Choices Manage Applicability Allows the user to create and modify applic Assign Applicability Allows users to assign precreated applic statements

54 Applicability in Action Manage Applic New Applic Screen Initial Screen as you enter from menu New Button allows you to create new applicability statements Modify allows user to modify existing statement XML Preview actually shows the current tagging

55 Applicability in Action Build Applic Applicability Plug-in Editor can select from all pre- configured applics or build a new applic Editor can create And or Or conditions New or Old Applic statements are easily modifiable

56 Applicability in Action Updated XML XML is updated When editor presses insert xml button the newly created/modified XML is inserted into the checkedout data module. Author has just built complex assert tagging.

57 Why Use Multimedia in S1000D Supporting the Technician in the field A picture is worth a thousand words Reduction of errors during maintenance due to concise interactive illustrations and multimedia In countries where English is not the primary language technicians can follow intuitive interactive illustrations and rely less upon the written word increasing technician effectiveness Cutting Costs Intelligent Interactive graphics and media objects reduce the amount of technical authoring narrative needed for support of complex tasks and procedures Reduction in narrative text leads to fewer written words increasing author productivity while reducing the cost of localization

58 Multimedia Authoring and Publishing Tool Requirements Ability to easily create Hot Spotted Graphics and Videos Utilization of 3d Technology Interactive callouts Step Driven Animation Zoom, Rotate, Explode on demand Ability to change views ( shaded, wireframe, API is critical Viewers and Sound Players Defined as part of Project Cost and Distribution Rights are critical

59 S1000D Multimedia Practices Multimedia in terms of S1000D Objects used to support presentation of Textual Data and must be considered secondary and not used in place of verified text Recommended that all multimedia objects are built in individual parts. A portion o of a media object that carries out a specific c function, eg sounds, images, action codes or video sections, can be used alone or combined with other parts Indication that the media object is loading and it s progress must be visible to the user Original material must be maintained in it s native form for reusability

60 Audio Audio can be a sound track, audible effect, or pure narrative heard to support, warn, and clarify procedure or diagnoses steps and actions Natural Sounds to clarify result of actions Bearing working well versus bearing making a sqeaking noise Audio that will enhance video, adding information required in performing the desired actions User controlled audio narration from validated S1000D DM s to enhance user understanding Aural warnings and audible alarms Flight deck Procedural crew

61 Audio Tagging Example <multimedia id="med-001"> <multimediaobject id="medobj-001 infoentityident="icn-s1000dbike-aaa-d u a-04-01" multimediatype="audio" showplugincontrols="show" xlink:actuate="onload" xlink:show="replace" xlink:title= S1000D Rocks - Audio Test"> </multimediaobject> </multimedia> <para>since it can be boring to tag xml all day we give you a multimedia example featuring <internalref internalrefid="medobj-001" internalreftargettype="multimediaobject" targettitle="blue Oyster Cult Test" xlink:href="medobj-001"> </internalref> </para>

62 Video Video Definition Video in S1000D Issue means real life moving images of Equipment actions Procedural steps Captured live events Generally linked not embedded within other media objects

63 S1000D in Action Mike Davis, Principal Business Analyst and S1000D Specialist

64 What we re going to demonstrate Manage and Automate Author Publish Deliver Electronically CCM/CSDB Contenta S1000D ORACLE Publishing Output XML Professional Publisher LiveContent Publishing Server Type 2 Interactive Electronic Technical Manuals Live Content Check in/out XML DB Editorial Workflow Arbortext Editor Data Module(s) Type 1 Paper/PDF Technical Manuals XSL-FO

65 Roundtable Moderator: Lou Iuppa Panelists: Mike Cook, Mike Davis and YOU!

66 Webinars, Workshops and Wrap Up Lou Iuppa, VP Business Development

67 Where can I go from here? SDL Your Source for S1000D Information SDL S1000D Resources Page (handout) SDL s Educational S1000D Recorded Webinars Series/Archive SDL S1000D Specification i Education Series Ask an S1000D Expert Tour Upcoming Events Webinars, Conferences, Tours Webinar Series: S1000D Applicability Boot Camp Part 3: The CCT Data Module November 9 On-Site S1000D Workshop AskAnS1000DExpert@sdl.com

68 SDL S1000D Online Webinar Recordings Register and View ALL the Recorded Events! 5 Part Series Part 1 S1000D Alphabet Soup: Introduction to S1000D Concepts Part 2 S1000D Content Workflow Part 3 S1000D Applicability Part 4 - S1000D Interactive Electronic Technical Publications (IETP) Part 5 - S1000D and Multimedia

69 SDL S1000D Specification Education Series Introduction to S1000D S1000D An In-Depth Exploration Authoring and Editing for S1000D Change Management (Editing/QA Cycle/Workflow) Front Matter An Exploration of the Possibilities Applicability An In-Depth Exploration of its Inner Workings Common Source Data Base (CSDB) What It Is, What It Can Do, What You Need to Know Project Startup for S1000D

70 Industry Conferences, Groups Industry Conferences S1000D User Forum AIA Techpubs Conference, Clearwater, FL each May Specs and User Groups Download the S1000D Spec for a little light reading! aspx S1000DPC User's Group LinkedIn S1000D Users Group

71 S1000D Workshop Objectives Gain a high level understanding 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 skills g Executive sponsor identified, and available for opening and close of workshop

72 Wrap Up Evaluation Form Literature Survival Tool Buddies

73 Contact Us!