Upload
trinhhanh
View
214
Download
0
Embed Size (px)
Citation preview
Ask an S1000D Expert™ TourSeattle, WA
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: S1000D Technology Conference
12:00 – 13:00 – Conference Registration, Networking and LunchLunch
13:00 – Introductions, Objectives, Market Trends13:10 – S1000D Overview
– S1000D – The Basics
13:30 – Boeing AWACS - Site Case Study14:00 Brief Break14:00 – Brief Break14:05 – S1000D in Action
– An IETM/IETP – Interactive Electronic Technical Manual / Publication A CSDB C S D t b– A CSDB - Common Source Database
15:00 - Brief Break15:05 - Roundtable15:45 - Final Q&A and Wrap Up
Objectives of this Conference
Explore S1000D Market TrendsUnderstand what you need to know about S1000D Overview of the basics The importance of a CSDB (Common Source Data Base) and the
publishing process to S1000DLearn from “The Real World” Site Case Study: The Boeing Company’s U.S. Airborne Warning and
Control System (AWACS) programy ( ) p g• Boeing Representative: Ed Hougardy, Programmer/Analyst, AWACSTechnical
Publications and Training
S1000D in Action SDL LiveContent and SDL Contenta S1000D
Roundtable: Ask, Share, Learn Ensure you walk away with the answers to your questions Ensure 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
Ed Hougardy, Programmer/AnalystProgrammer/AnalystAirborne Warning and Control System (AWACS) Technical Publications and Training
Ed supports AWACS data transformation strategies that meet the online and print delivery requirements for the program. Ed’s efforts also focus on the identification and delivery of data authoring
i tprocess improvements.
Recent projects include data transformation and style development for the AWACS Interactive Electronic Technical Manual (IETM) ( )Viewer, and for the Boeing Collaborative Document Reviewer, a state-of-the-art web application used to automate the Interim Product Review (IPR) process for product document review.
Ed’s expertise is valued across multiple programs and sites and he is an active participant in the Boeing S1000D™ Working Group.
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
S1000D Overview Slides
S1000D basics History Terminology Important activities Support files Marketplace overview
How do you get there?• Crossing the road to adoption• Crossing the road to adoption
The Larger context Challenges of adoption Best of Breed S1000D Implementations Best of Breed S1000D Implementations The myth of the end-to-end solution The best of breed solution Th CSDB tt The CSDB matters Why publishing matters
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.
S1000D History
The specification is managed by working groups who represent various industries or users. Prominent working groups are “U.S. Specification Management Group” (USSMG) and the Civil Aviation Working Group (CAWG). These groups have contributed to developing and maintaining the S1000D specification.
To assist the USSMG in defining and submitting U.S. interests, the “U.S. Specification Implementation Group” (USSIG) was established as a sub group of the USSMG to recommend detailed technicalas a sub group of the USSMG to recommend detailed technical solutions, perform feasibility reviews, submit change proposals, and advise USSMG on future areas of interest.
Aerospace Industries Association (AIA) manages the USSMG and the USSIG.
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 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)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)
S1000D Marketplace Overview
S1000D adoption is growing much faster than expected in the Military and Civil Aviation industryThe U.S. Air Force has standardized all new projects to use S1000D Spec 4.0.1. Aerial refueling tanker is a case in point.po t U.S. Air Force is undergoing S1000D trials to replace 38784 and
electronically manage publications and Technical Work Orders
Mil-STD 3031 – U S Army has created standardizedMil-STD 3031 – U.S. Army has created standardized business rules for new projects to use S1000D Issue 4.0.1Joint Chiefs have also issued a draft memo from the U d f D f f A i i i T h l dUndersecretary of Defense for Acquisition, Technology and Logistics, recommending S1000D as the standard of choice for documentation associated with all new weapon systems
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 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: Challenges of Adoption
What is Needed Details Impediments to successDeep knowledge of the • Knowledge of terminology,
understanding of S000DLearning curve
specification understanding of S000D concepts and coding rules
Defining the business rules so as to manage
• Learning to write to the datamodule paradigm
• New workflow methods to
Psychology of change, new methods, identifying
changes to the authoring environment
New workflow methods to support authoring, review, editing, and publishing cycle
what needs to change in an existing environment
Technical know-how • Knowing how to work with XML,publishing basics and IETP
Human resources, access t i ti i f tipublishing basics, and IETP
experience• Experience with a CMS
to existing information on the spec, etc
Technology infrastructure • Authoring Tools• CSDB
Flexibility, support, programming/macro• Publishing Engine
• APIs to Integrate with Other systems (LSAR/Parts/Wiring)
programming/macrolanguage capabilities, compliance to spec
File/data exchange • Subcontractors, OEMs, and Seamless data exchangeFile/data exchange between partners
, ,Service organizations must all adopt S1000D
Seamless data exchange between organizations
Best of Breed S1000D Implementation
PublishingProduct Lifecycle Management
Technical Content Development
Logistics Management
P d t
Client Applications
P t d tProduct information
PLM digital content
Part data
CSDBIETP
LSAR
Each of these applications representpp pcomplex processes and specific
expertise. No single vendor has the expertise to do all of it well.
The Myth of the End-to-End Solution
Single Vendor, In Theory Single Vendor, In Reality
• One vendor can provide all components • Each component is complex in its own right• One vendor can provide all components of the solution
Each component is complex in its own right• No single vendor can do all parts equally well• You will feel pressure to buy components you don’t need• Components created to fill a perceived product gap are
designed to sell a suite of products rather than to meet customer production requirements with an industrial-strength solution
• All components are made by the same vendor and will integrate “out of the box” with each other
• Software components are developed and maintained by different business units with different development centersIntegration is rarely “one size fits all”; so “out of the box”with each other • Integration is rarely “one-size-fits-all”; so “out-of-the-box” integration is not likely to meet your needs and will require customization anyway
• In most cases, integration is not a difficult or time-consuming effort; it doesn’t justify forcing a single-vendor solution
Th “ i l d ” th hid d k i• You get all the functionality you need • The “single vendor” theory hides gaps and weaknesses in products; vendors focus on their best components (e.g., Arbortext Editor)
• Demonstrations of the worst components are avoided (e.g., publishing to paper and/or IETP)
• Some point solutions are better than others; with a single• Some point solutions are better than others; with a single vendor, you do not have the flexibility to choose the solutions that best meet your specific needs
The Best of Breed Solution
Specialization breeds focus and expertiseYou get to work with top of the line applications in each g p ppsegmentYou get to keep the parts of your infrastructure that are already workingalready workingYou can more nimbly adopt newer and better technology and standards“All your eggs are not in one basket”; you can swap out software components without disrupting your entire operationoperation
Authoring is not Content Management
Some vendors try to simplify the requirements around S1000D by focusing on authoring toolsAuthoring is important, but does not address the major requirements associated with S1000D: DMRL creation DMRL creation DMC and ICN creation and management Publication module creation and management Data interchange using a DDN Data interchange using a DDN Multi-channel publishing outputs (PDF, IETP)
These tasks are performed by the IT department and ll i i t i i t ti ith th CSDBgenerally require intensive interaction with the CSDB
Find a good XML Editor for authoring and a good CSDB for the management of S1000D content—focus on built-in gfunctionality to handle the major requirements listed above
Why the CSDB Matters
The CSDB is the focal point of all your data A CSDB is the primary storage location for all content Without a central location for organizing and tracking information,
important information can be lost or overlooked
What you need in a good CSDB:y g Ability to work in the S1000D formats you choose Workflow management (editing cycle) Intuitive method for importing or exporting content using a DDN Intuitive method for importing or exporting content using a DDN
(automated DDN creation, DM export and import) Capability to manage DMCs and ICNs, not just the codes, but also any
associated nomenclature Capability to create and manage Publication Modules as “virtual
documents” so links to XML objects are not entered manually Capability to publishing to multiple output formats (aka Multi-channel
publishing) from the same content IETP “preview functionality” for authors
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 use your contente te a custo e s use you co te tS1000D 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 and text to graphic linking capabilitiestext, text-to-text, and text-to-graphic linking capabilities Customizable “skins” and styles; open architecture Support for Process Data Modules and links to external applications R i i hi hli ht d i t l d t f ti lit Revision highlights and incremental update functionality Annotations and built-in problem reporting Audit trails and forms capabilities
S1000D Best Practices for Deployment
1 2 3 4Primary Responsibility
SDL W k hSDL W k h I l t tiI l t ti
Months
S t fi ti S t fi ti SDL Workshop(out-of-the-box)SDL Workshop
(out-of-the-box)Implementation
WorkshopImplementation
WorkshopSDL
Adoption, content reuse,Adoption, content reuse, Client Client
System configuration and deployment
System configuration and deployment
L S1000DL S1000D
Style sheetsfinalized
Style sheetsfinalized
Adoption, content reuse,and change managementAdoption, content reuse,and change management
CustomerBusiness Rule decisions (document and apply to BREX DM)Business Rule decisions (document and apply to BREX DM)
Setup and Setup and
Client sign offClient
sign offLearn S1000DLearn S1000D
LiveRelease!LiveRelease!
Install Configured SDL Install Configured SDL IT / Admin Setup and Configure Server
Setup and Configure Server
SDL or Consultant S1000D S1000D
Content Creation and ConversionContent Creation and Conversion
Install Configured SDL Server
Install Configured SDL Server
IETM StylesIETM StylesS1000D
Author TrainingS1000D
Author Training
Who is Ed HougardyWho is Ed Hougardy
I’m a programmer/analyst with The Boeing Company, in the Defense, Space & Security business unit. Specifically, I work for the Airborne Warning and Control System (AWACS) technical publications group i K t WAin Kent, WA: Currently, sixty six 707 AWACS aircraft, designated the E-3, are in
service worldwide within the United States, NATO, Saudi Arabia, France, and United Kingdom, g
Japan uses four 767 AWACS
My primary role involves the management of and transformation of technical maintenance datatransformation of technical maintenance data.
BackgroundBackground
In the mid 1990s NATO planned a major upgrade to the NATO Mission Systems NAPMA decided to look into possibility for Interactive
Electronic Technical Manuals (IETM) No knowledge available No concept available
Working group established in 1995Working group established in 1995 Research feasibility for IETM for NATO AWACS major
“Modernization Programme” (NATO Midterm) Define basic conceptDefine basic concept
Leaping Ahead ~ Pilot ProjectLeaping Ahead Pilot Project
Data Conversion and Viewer development contracts awarded to ESG GmbH, Germany in 1996 AECMA (ASD) 1000D version 1.6 Data in SGML
Close cooperation between contractor and NATO working group
Lessons learned
Moving ForwardMoving Forward
Advantages found Quick and easy access to data, easy to use Distribution Functionalities Only limited user training required
New Technical Maintenance DataM d t 1000D i 1 7 Moved to 1000D version 1.7
TOC 1000d version 1.9
Tools developed for QATools developed for QA Check compliance with “Data Interchange Specification” Identifies location of errors Must pass prior to deliveryMust pass prior to delivery
U.S. AWACS Upgrade ~ The Big PictureU.S. AWACS Upgrade The Big Picture
The largest upgrade in the history of the U.S. AWACS fleet is underway: With new mission computing hardware and software,
upgraded radar equipment, navigation and communications systems These systems are designed to increase thesystems. These systems are designed to increase the AWACS’ capability, reliability and lower its life cycle costs
Upgrades will be installed on the entire U.S. fleet of 32 AWACS by 2016
New Opportunities for the Technical Publications Group: Creating data (information) right the first time Improved In-Process Reviews (IPRs) Giving the customer what they want Transition paper to electronic media
Boeing U.S. AWACS HistoryBoeing U.S. AWACS History
Pre-upgrade state of the AWACS publications: Develop system/equipment specific maintenance and
operation manuals using United States Defense Standards for Technical Orders (MIL-SPEC/MIL-STD)( ) Manuals created/maintained with various programs, such as BroadVision
Interleaf, Adobe FrameMaker, and SGML data authored with Arbortext Editor and formatted with SDL’s XPP
Several MIL-SPECS are employed such as, MIL-STD-38784 for General Maintenance Manuals; MIL-PRF-7700G for Basic Flight Manuals; MIL-PRF-5096F for Work Cards
Moving ForwardMoving Forward
New state of the AWACS publications: Develop system/equipment specific maintenance and
operation data products using S1000D™ S1000D™ is an international specification for technical publications,
utilizing a common source database (CSDB)utilizing a common source database (CSDB). 1000s of XML data modules authored with Arbortext Editor and
maintained in SDL’s Contenta Cost savings associated with reuse of information
S bject matter e pert a thoring Subject matter expert authoring Web 2.0 Based IPR support tool
Supports review of S1000D data Content Management System employedContent Management System employed
Adds revision/history control to data Adds “meta-data” for information control systems
How We Got ThereHow We Got There
Established Boeing / Customer (Air Force) S1000D Business Rules Team Business Rules can make or break a project
Business Rules define how the project is going to create, manage, and deliver technical contentdeliver technical content.
The S1000D™ specification (Issue 4.0.1) has nearly 700 paragraphs that contain Business Rules Decisions information.
The S1000D™ specification (Issue 4.0.1) has identified ten categories for all major business rules decisions:for all major business rules decisions:
• General business rules • Data creation business rules• Product definition business rules • Data exchange business rules• Maintenance philosophy & concepts of operation • Data integrity and management • Security business rules • Legacy data conversion & managementSecurity business rules Legacy data conversion & management• Business process business rules • Data output business rules
How We Got There continuedHow We Got There continued
Business Rules Team Team was made up of representatives from several
disciplines / groups The customer Authoring staff Illustration staff Information Technology Staff S1000D Subject Matter Expert
Programmers Arbortext Developer
St l h t / FOSI D l Stylesheet / FOSI Developer Schema / DTD Subject Matter Expert
Team Lead (Managers / Focal) Team Scribe – Document the decisionsTeam Scribe Document the decisions 3rd party vendors / subcontractors when appropriate
How We Got There continuedHow We Got There continued
Team decisions Determine which version of S1000D™ to be used Identify content to be managed Content (scope) of the Data Modules( p )
Line Replacement Module (LRM) / Line Replaceable Unit (LRU) Logistics Databases
Data Module outputEl t i Electronic
Printed Both
Functionality Matrix from the S1000D specificationFunctionality Matrix from the S1000D specification Types of Data Modules Media types (output)
How We Got There continuedHow We Got There continued
Team Empowerment Have invested one hour week meeting time for four years Established that Business Rules are a living document –
revisiting is OK Accepted that change is inevitable (paradigm shift)
Business Rules SummaryBusiness Rules Summary
Started the project with Issue 2.0 of the specification, migrated to Issue 3.0 and now brought the data forward to Issue 4.0.1 At the start of the project developed with our customer a set
f B i R l Th l i f dof Business Rules. These rules primary focused on: Authoring guidelines for content creators Element and Attribute usage Information Code usageInformation Code usage
As the data migrated to newer versions of the specification: Business Rules were updated to take advantage of new elements and
functionality and element/attribute name changesC B i R l f did t h Core Business Rules focus did not change
Challenges Faced by The Technical g yPublications Group Challenges caused by this changing situation: New standard for authoring Authoring permissions and workflow control Complex workflowp
Reviewing data within Boeing and our military customer Potential for complex delivery requirements
Authoring WorkflowAuthoring Workflow
Strategies to meet authoring challenges of the new specification Provide training Develop custom application plug-ins to assist authors with
repetitive tasks Use “Business Rules” Provide QA and “Business Rules” checking application CMS / CSDB
Authoring Revision Change management
The In-Process Review ProblemThe In Process Review Problem
Extremely complex workflow between Boeing and the Air Force: Produce, print, and ship copies of data products to the
various customers required to perform review Hand mark review copies for correction/change Transfer markups to Air Force form 158 to formally record
commentsG th ll i i t t d t i d t d t Gather all reviewers interested to review data products
Find repetitive comments Perform a line by line review of documents and all comments
mademade Compile all comments and incorporate into data product
Boeing Collaborative Document ReviewerBoeing Collaborative Document Reviewer
The In-Process Review solution BCDR: Web based / Server Hosted Tool
Documents are uploaded to web server (XHTML, XML, PDF) Documents Support S1000D and IETM look and feel
Just In Time Processing Just-In-Time Processing Workflow support
Band Width Efficient Graphics don’t load until neededp XHTML page does not require reload when adding/updating comments
Collaborative Asynchronous, group reviewing Sticky-note like comments Real time - Server updates every 15 seconds Comments embedded within document at original location Everyone comments, everyone sees everyone else’s commentsy , y y
SuccessSuccess
The Boeing AWACS Technical Publications Group: Has delivered to the U.S. Air Force – S1000D data which has
passed “Verification”
Key to success:Key to success: Close cooperation between all parties Government,
Contractors, and Vendors is must for a successful result
FutureFuture
S1000D 4.1 Consider updates to the specification
Joint USAF and NAMPA project Common approach data reuse Common approach – data reuse Training data is planned to be included Flight Manual data
More legacy paper based Technical Orders to be converted to S1000D
ConclusionConclusion
When implemented correctly, a S1000D™ project has p y, p jthe potential of providing a cost effective, standards based, interactive solution for technical data presentation.p Provides a generic concept for quality assurance of
publications in a life-cycle perspective Provides standardized transfer format for exchange of g
information between any organization Promotes content reuse and repurposing
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
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/• June 1, 2011 – “Should S1000D be required by the Department of
Defense?”• July, 2011 – “A best practices approach to S1000D data conversion.”
On-Site S1000D Workshop
AskAnS1000DExpert@sdl [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
SDL’s Ask an S1000D Expert™ Tour
San Diego, CA – June 2011 Naval Postgraduate School – “Should S1000D be required
by the Department of Defense”. • S1000D as an acquisition strategy.
Fort Worth, TX – September 2011 US Navy, PMS401 – Acoustic Submarine Program – “A TeamSub
S1000D Strategy”
Warner Robins, GA – October 2011, ADL – The case for integrating Tech Data and Training
Washington, DC - November 2011 Lockheed Martin – “S1000D, a tactical advantage.” A best practices
approach to integrating tech data and tactical systems.
// / / / /http://www.sdl.com/en/xml/events/
Industry Conferences, Groups
Industry Conferences June 6 to 8 - S1000D User Forum 2011 in Montreal June 6 to 8 - S1000D User Forum 2011 in Montreal
• 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