S1000D Steering Committee Modularization Report …public.s1000d.org/Documents/2015 S1000D User Forum...September 21‐23, 2015 S1000D Steering Committee Modularization Report to User

September 21‐23, 2015

S1000D Steering Committee Modularization Report to User Forum 2015

Material Produced by Jan Haslam, Ian Hill, Dr. Andreas Schuetze

Presenter Name: Jan HaslamRank or Title: FellowOrganization: Lockheed Martin

BACKGROUND

Current Limitations

• S1000D is complex to implement – Project ‐ what to use or not, and how to do it – Supplier – inconsistent or conflicting customer requirements

– Software vendor ‐ possibly only partial coverage

• Difficult to evolve (limit evolutions)– Integrating new needs– Integrating other standards from ASD, PLCS, SCORM, etc.– Managing competition in the standardization world

• Risk: proprietary add‐ons for projects – Timely integration of program/project needs

Current Limitations• Specification growth• Permanent conflict between 2 basic requirements:

– Keep the spec simple and easy to implement– Provide new advanced mechanisms required for new projects

• 2 orthogonal methods of production and delivery of DMs and publication: Self‐contained vs. repository‐dependent data modules

• Consequences:– New mechanisms = project decision points and more Business Rules– Multiple approaches – More complex, time‐consuming, and costly to implement

The Council GoalsThe specification must:• be agile• be efficient• be interoperable• be data module centric• be platform neutral• have consistent data structures• leverage other standards• meet applicable regulatory requirements• enable optimum reuse• be based on a modular approach

The Council Goals

ExchangeFoundation Block

Publication Foundation Block

Exchange Building BlocksPublication Building Blocks

S1000D Foundation Block

S1000D Building Blocks

A modular based specificationFoundations and optional building blocks

The Council Goals“To be based on a modular approach”

• Comprised of foundations and optional building blocks

• No alternative solutions for the same business requirement

• Optional building blocks can be added to the foundations singularly or in combination (extendable by modules)

Benefits

• Foundation of the spec is more stable and simple– Minimize & simplify business rules decision points– Software implementation could be more standard compliant

• Agile Building Block mechanism to implement new needs in S1000D

S1000D SpecIssue x.y

Building Block Library

BR

+

CURRENT PROGRESS

Modularization Concepts

• Modularization concepts have been defined– Foundation and Building Blocks– Externalized concepts identified– High‐level table of content identified– Prototype developed for building block creation around a concept

Proposed FoundationFoundation S1000D Chaps (4.1) 1 Schemas (if applic.) TT/WGs

DM concept & constructs (IDSTATUS/content)

3, 3.1, 3.2, 3.6, 3.7, 3.9.5, 3.9.5.1, 3.9.5.2, & 3.9.5.2.1

SC & EPWG

CSDB 4.2, 7.3 2 SC & EPWG

Other general S1000D concepts 3

1, 2, 3.3, 3.4, 3.8, 3.9, 3.9.1, 3.9.3, 3.9.5*, 3.9.6, 4, 4.1, 4.17, 4.12, & 9

xlink SC & EPWG

BREX 4.10, 7.9 brex SC & BRWG

Applicability 3.9.5.3, 4.14, & 7.8 appliccrossreftable, condcrossreftable, prdcrossreftable

SC & Applicability Task Team

Interchange & update concepts

3.5, 4.5, 4.7, 4.8, 7, 7.1, 7.2, 7.4, 7.5, 7.6, & 7.7

ddn, dml, dc, rdf SC & EPWG

Publication module 4.9 pm SC & EPWG

DMC, PMC, ICN, SNS, IC numbering 4

4.3, 4.4, 8, 8.1, & 8.4 SC & EPWG

Descriptive 3.9.5.2.2 descript SC & EPWG

Procedural 3.9.5.2.3 proced SC & EPWG

General S1000D ConceptsChap Detail

1 Introduction, How To Use, CPFs, etc.

2 Documentation process, Business rules concepts

3.3 Information sets concept (not the Chap 5 maintained information sets)

3.4 Zone and access concept

3.8 Disassembly principles

3.9 Authoring introduction

3.9.1 General writing rules

3.9.3 Alerts (warnings, cautions , & notes)

3.9.5 Authoring data modules

3.9.6 Authoring attributes

4 & 4.1 Information management

4.12 Data module code extension

4.16 Paragraph significant data & quantity data (may be better defined as “DM Concept and Constructs”)

9 Terms and data dictionary

Proposed Building Blocks

Block S1000D Chaps (4.1) Schema TT/WG

Training/Learning 3.9.7, 3.9.5.2.13, 3.9.5.2.17, 3.9.7, 4.15, & 8.5

learning, scocontent, scormcontentpackage

Learning Standards Harmonization Task Team

Comment 4.6 comment

Front matter (schema) 3.9.4 & 3.9.5.2.16 frontmatter

CIR 3.9.5.2.11 & 4.13 comrep, update, Technical Information Repository Task Team

Container 3.9.5.2.12 & 4.13 container

Maintained SNS 8.2 & 8.3

Information sets (maintained) 5

Illustration rules 3.9.2, 7.3.2 xcf Multimedia Task Team

Presentation rules 6, 6.1, 6.2, & 6.3

Functionality matrix 6.4

Proposed Building Blocks (Cont’d)

Block S1000D Chaps (4.1) Schema TT/WG

Crew 3.9.5.2.6 crew

Process 3.9.5.2.10, 4.11 process

Wiring 3.9.5.2.9 wrngdata, wrngflds

Parts 3.9.5.2.7 ipd Generic IPD Task Team

Fault 3.9.5.2.4 fault

Maintenance/Schedule 3.9.5.2.5 schedule

Checklist 3.9.5.2.14 checklist

Component maintenance Component Maintenance Publications Task Team

BDAR 3.9.5.2.8

Service bulletins 3.9.5.2.15 sb Service Bulletin Task Team

Foundation, Building Blocks and Externalized Concepts

Imagine the S1000D specification as a three volume set.Lets take a look inside each one…..

S1000DFoundation

S1000DBuilding

Blocks

S1000DExternalizedInformation

Foundation, Building Block andExternalized Concepts

S1000D Foundation Definition

• Minimum set of features that any project could use to implement S1000D.

• The Foundation must be usable without additional Building Blocks.

• Not all Foundation features have to be used by a project. The use of optional Foundation features will be subject to BRDPs.

Table of Contents

- General S1000D concepts - DM concept & constructs - (IDSTATUS/content)- Interchange & update concepts- Descriptive- Procedural- Basic Applicability- CSDB- DMC, PMC, ICN, SNS, IC numbering - Publication module- BREX

Guidelines linked to Foundation:• Small number of BRDPs• Specific change process criteria• New Building Blocks should not

affect Foundation


S1000D Foundation Block Definitions

General S1000D concepts:• Basic information about S1000D • How it is applied as a framework for

the Creation, Maintenance and Delivery of Technical Information

DM concept & constructs (IDSTATUS/content):• The portions of the specification

describing the Data Module concept

Interchange & update concepts:• The portions of the specification

describing the methodology of interchanging and updating Technical Information

.

Descriptive:• The specification of the Descriptive

Data Module construct, encoding and content

Procedural:• The specification of the Procedural


Basic Applicability:• The portions of the specification

describing the general concept of Applicability, the Applicability model and the encoding of the applicability data for human readability

CSDB:• The portions of the specification

describing the concept of the Common Source Data-Base and its use


S1000D Foundation Block Definitions

DMC, PMC, ICN, SNS, IC numbering:The specification of the various numbering systems

Publication module:The specification of the Publication Module construct, encoding and content

BREX:The portions of the specification describing the Business Rules Exchange concept and the specification of the BREX data module construct, encoding and content


S1000D Building Blocks Definition

• An optional module opted for at project discretion

Table of Contents- Zoning- Illustration and Multimedia rules- Front matter (schema)- Controlled Content- Reuse- Fault- Maintenance/Schedule- Crew- Parts- BDAR- Wiring- Process- CIR- Container- Training/Learning- Checklist- Service bulletins- Computable Applicability- Comment- Information sets (maintained)- Presentation rules- Functionality matrix


S1000D Building Blocks Definitions

Zoning:Describes product zoning and access with corresponding identification

Illustration and Multimedia rules:Describes data formats and their use for Illustrations and Multimedia

Front matter (schema):Front Matter Data Module construct, encoding and content

Controlled Content:Describes data encoding and supply to allow a data receiver to augment or modify technical content prior to its publication

.

.

Reuse:Describes the mechanisms that allow data reuse to maximise flexibility whilst minimising data creation /maintenance burden

Fault:Fault Data Module construct, encoding and content

Maintenance/Schedule:Maintenance/Schedule and Crew Data Module construct, encoding and content

Crew:Crew Data Module construct, encoding and content



Parts:• Parts Data Module construct,

encoding and content

BDAR:• Battle Damage Assessment and

Repair Data Module construct, encoding and content. (Schema does not yet exist)

Wiring:• Wiring Data Module construct,


Process:• Process Data Module construct,


CIR:• Common Information Repository


Container:• Container Data Module construct,


Training/Learning:• Learning Data Module construct,

encoding, content, rendering and the interaction with SCORM

Checklist:• Checklist Data Module construct,


Service bulletins:• Service Bulletin Data Module

construct, encoding and content



Computable Applicability:• Describes the advanced concept of

Computable Applicability for dynamically filtering the delivered data to a specific product and/or environmental condition

Comment:• Comment Form construct, encoding

and content

Information sets (maintained):• Describes the concept of Information

sets and their intended use

Presentation rules:• Guidance for Technical Information

presentation

Functionality matrix:• Describes the various levels of IETP

functionality


S1000D Externalized Information Definition

Table of ContentsData module Schema - Issue summaryChap 7.3.1.1.1 Issue summary - Versions 2.0 and 2.1Chap 7.3.1.1.2 Issue summary - Versions 2.2 and 2.2.1Chap 7.3.1.1.3 Issue summary - Versions 2.3 and 2.3.1Chap 7.3.1.1.4 Issue summary - Versions 3.0 and 3.0.1Chap 7.3.1.1.5 Issue summary - Issues 4.0 and 4.0.1Chap 7.3.1.1.6 Issue summary - Issue 4.1

Data module Schema - Backwards compatibilityChap 7.3.1.4.1 Backwards compatibility - Version 2.0Chap 7.3.1.4.2 Backwards compatibility - Version 2.1Chap 7.3.1.4.3 Backwards compatibility - Version 2.2Chap 7.3.1.4.4 Backwards compatibility - Version 2.3Chap 7.3.1.4.5 Backwards compatibility - Version 3.0Chap 7.3.1.4.6 Backwards compatibility - Issue 4.0Chap 7.3.1.4.7 Backwards compatibility - Issue 4.1

Publication module Schema - Issue summaryChap 7.4.2.1.1 Issue summary - Versions 2.0 and 2.1Chap 7.4.2.1.2 Issue summary - Version 2.2Chap 7.4.2.1.3 Issue summary - Versions 2.3Chap 7.4.2.1.4 Issue summary -Versions 3.0Chap 7.4.2.1.5 Issue summary - Issues 4.0Chap 7.4.2.1.6 Issue summary - Issue 4.1

Maintained SNSChap 8.2.1 Maintained SNS - GenericChap 8.2.2 Maintained SNS - Support and training equipmentChap 8.2.3 Maintained SNS - OrdnanceChap 8.2.4 Maintained SNS - General communicationsChap 8.2.5 Maintained SNS - Air vehicle, engines and equipmentChap 8.2.6 Maintained SNS - Tactical missilesChap 8.2.7 Maintained SNS - General surface vehiclesChap 8.2.8 Maintained SNS - General sea vehicles

Information codesChap 8.4.1 Information codes - Short definitionsChap 8.4.2 Information codes - Full definitions

Learn codes Chap 8.5.1 Learn codes - Human performance technology codesChap 8.5.2 Learn codes - Training codes

Information that is managed separately from the narrative S1000D specification to avoid

overload of historical information OR

to ease information update that might be changed independently

Prototype Concepts• A prototype Block for the Foundation Block, Basic Applicability, and the Building Block – Computable Applicability has been developed to prove the concepts

– SC has reviewed and agree they provide a viable method of documenting the content needed in the block and the editorial work required

Dependencies

• XML Conversion– S1000D must be converted to XML prior to modularization effort

• XMLTT is undertaking planning to convert following Issue 4.2

• Specification maintenance– SC has reviewed proposal on Modularized Specification Maintenance

– Affords easier and more responsive updating