NAVSEA S1000D Tool Chestpublic.s1000d.org/Documents/2015 S1000D User Forum presentations... · NAVSEA S1000D Tool Chest NAVSEA S1000D TOOL CHEST Support Groups U.S. S1000D Sea Working

NAVSEA S1000D Tool Chest

NAVSEA S1000D Tool ChestL. John Junod - Chair U.S. S1000D Sea Working Group

(Naval Surface Warfare Center-Carderock Division)Wayne Gafford - Moderator

(Naval Surface Warfare Center-Port Hueneme Division)Phil Deuell (AMSEC)

2015 U.S. S1000D User ForumSan Diego, California

1Distribution Statement A: Approve for Public Release; distribution is unlimited


NAVSEA S1000D Tool Chest Presentation Agenda

TM Acquisition Manager’s Goals• Develop a Strong Technical Manual

Contract Requirement (TMCR)– Gather Resources– Identify Technical Manual Content– Specify Business Rules and Register Model

Identifier– Specify Quality Assurance Requirements– Prepare Solicitation

• Produce Technical Manual– CSDB– Publishing Engine– NAVSEA TM Viewer

2

Gather Resources

Identify Technical Manual Content

Specify Quality Assurance Requirements

Specify Business Rules and Register Model Identifier

Prepare Solicitation

Produce Technical Manual

Distribution Statement A: Approve for Public Release; distribution is unlimited


NAVSEA S1000D TOOL CHEST

Support Groups

U.S. S1000D Sea Working

Group

NAVSEA S1000D Configuration Control Board

NAVSEA TM Viewer Configuration Review

Board

Enterprise Resources

NavyS1000D

InformationCenter

Website

TMManagement

Program Operations

and Procedures

NAVSEA S1000D

Acquisition and

Development Procedures

NAVSEA TM Management

Course(with S1000D)

NAVSEAS1000D

Info Sets

Project Resources Business

Rules

Model Identification

CodeRegistration

NAVSEA S1000D Tagging and Authoring Guidelines

CSDB User

Manual

Policies Department of Navy Policy on Digital Product/Technical Data

NAVSEA Policy: Use of S1000D

Production Tools

SMART-T(TM Contract Requirements

Tool )

Data Item Descriptions

QualityAssurance

andS1000DBREX

CSDB PublishingEngine

NAVSEATM

Viewer

3

Gather Resources








Gather Resources

4

Gather Resources






Support Groups


Group



Board


NavyS1000D

InformationCenter

Website

TMManagement

Program Operations

and Procedures

NAVSEA S1000D

Acquisition and



Course(with S1000D)




Rules



Gather Resources

5

2. Review Joint Service (JS),

DON, NAVSEA, Community

Business Rules

1. Revew NAVSEA S1000D

Acquisition Guidance

Policies Department of Navy Policy on

Digital Product/Technical Data

Gather Resources






What: Directs the establishment of an Integrated Digital Data Environment (IDDE) to achieve the goals and benefits of digital operations.

Action: Plan, procure and accept delivery of product/technical data in digital formats.

Explanation: S1000D satisfies the recommendation that all new technical manuals should be acquired and authored in XML in accordance with the W3C recommendation.

Go to full policy letterhttp://www.navsea.navy.mil/Portals/103/Documents/NSWC_Carderock/Policy.Guidance.041023.pdf



Gather Resources

6

Gather Resources






Go to full policy letter

What: Clarifies policy, responsibilities and required actions regarding use of S1000D in the NAVSEA Technical Manual Management Program (TMMP).

Action: NAVSEA activities and programs may use S1000D for the acquisition and development of TMs.

Explanation: S1000D can be used when implemented with the appropriate business rules and NAVSEA information sets.

http://www.navsea.navy.mil/Portals/103/Documents/NSWC_Carderock/DOC004.pdf

Policies NAVSEA Policy: Use of S1000D



Business Rules





Gather Resources

7

Support Groups

U.S. S1000D Sea Working Group

Gather Resources






What: Twice-yearly working group meeting attended by U.S. maritime interests, including the Navy, Coast Guard, Marine Corps and industry shipbuilders.

Action: Current and upcoming S1000D specification issues are reported and tracked. S1000D lessons-learned are presented, including applicability, business rules, tagging and content management. Circulate and discuss S1000D acquisition rationale and life cycle support. Provide useful demonstrations of S1000D applications. The U.S. SWG serves as the focal point for determining where U.S. Sea S1000D Change Proposal Forms (CPFs) are needed and where adjustments to requirements can be made. The SWG elevates approved CPFs to the USSMG.

Explanation: The Working Group received its authority from the US S1000D Management Group (USSMG) and is comprised of US Department of Defense (DoD) and industry members. A DoD representative approved by the USSMG serves as Chair of the SWG.

Go to SWG Web Site(Requires DoD CAC Card)



Business Rules



https://efs-east.deps.mil/Navy/seas1000d/SitePages/Home.aspx



Gather Resources

8

Support Groups


Gather Resources








Business Rules



What: Twice-yearly working group meeting focusing on NAVSEA-only S1000D implementations.

Action: Current and upcoming NAVSEA-specific issues are reported and tracked. Issues include business rules, information sets used to acquire required technical content, enterprise software products, acquisition processes and life cycle support of S1000D-compliant TMs, change requests for NAVSEA technical manual management program and quality assurance (QA) requirements.

Explanation: The Configuration Control Board received its authority from NAVSEA Headquarters, is chaired by NSWC Carderock, and is comprised of NAVSEA commands and programs.

Go to SEA WG Change Proposals for CCB

http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/S1000DInfoCenter/NAVSEAS1000DAcquisitionProcess/USSWGS1000DCPFs.aspx



Gather Resources

9


Navy S1000D Information

Center Website

Gather Resources








Business Rules



What: An evolving information resource center focused on the Navy S1000D community of practice.

Action: Used to advocate and coordinate the needs and interests of U.S. Navy, NAVSEA and the U.S. maritime community in the S1000D specification development and implementation space.

Explanation: Focus is on Department of Navy business rules, acquisition processes, policy references, XML/SGML schema repositories and points of contact.

Go to information center http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/S1000DInfoCenter.aspx



Gather Resources

10


TMManagement Program

Operationsand Procedures

Gather Resources








Business Rules



What: Document Title: NAVSEA TECHNICAL MANUAL MANAGEMENT PROGRAM OPERATIONS AND LIFE CYCLE SUPPORT PROCEDURES

Action: This manual addresses the operation, implementation and execution of the TMMP policies and business processes required by NAVSEA Instruction (NAVSEAINST) 4160.3B.

Explanation: This manual focuses on the four principle phases of the TM Life Cycle: Definition, Development, Distribution, and Disposal. It includes descriptions of functions, explanations of processes and references to additional sources of information. Go to full manual

(Requires DoD CAC card) thttps://nsdsa.nmci.navy.mil/nsdsarepository/B003 000_S0005-AA-PRO-010.pdf



Gather Resources

11


NAVSEA S1000D Acquisition and


Gather Resources








Business Rules



What: Document Title: PROCEDURES FOR THE ACQUISITION AND DEVELOPMENT OF NAVSEA TMS/IETMS IN ACCORDANCE WITH THE INTERNATIONAL SPECIFICATION S1000D.

Action: This document establishes S1000D acquisition and development procedures for NAVSEA programs.

Explanation: The acquisition and development procedures describe what to implement in the NAVSEA S1000D TMMP environment. The procedures are written for TM definition and development processes. This document is a companion document to the TMMP.

Go to NAVSEA S1000D Acquisition documenthhttp://www.navsea.navy.mil/Portals/103/Documents/NSWC_Carderock/NSWCCD-20-TR-2011-06%20S1000D%20IETM%20Acq%20Guide%202011Oct.pdf




12

Gather Resources






Enterprise Resources NAVSEA

S1000DInfo Sets




13


NAVSEAS1000D

Info Sets3. Identify Type of Manual: HM&E TRS Etc.

4. Specify Desired TM CapabilityA Spiral Process

6. Develop Initial List of required

DMs

4.1 Specify S1000D Issue Number

4.3 Specify TM Functional

Requirements

4.2 Identify Content

Requirements & Select Content Info

Set types

4.2.1 NAVSEA

Information Sets

4.3.1 NAVSEA S1000D

Functionality Matrix

Gather Resources

Identify Technical Manual

Content

Specify Quality Assurance

Requirements

Specify Business Rules and

Register Model Identifier



What: NAVSEA S1000D Info Sets describe the variety of technical information required to be authored and published in a TM.

Action: NAVSEA S1000D Info Sets are exclusively based on the content requirements in MIL-DTL-24784. A NAVSEA S1000D Info Set provides an author with corresponding S1000D information codes and their related schemas. Explanation:

5.N.1.1 Front and Rear Matter Info Set5.N.1.2 Graphics Info Set5.N.1.3 Safety Info Set5.N.1.4 IPD Info Set5.N.2 COTS Info Set5.N.4 Technical Repair Standard Info Sets5.N.5 TAB Info Set5.N.6 SIB Info Set5.N.7 CSTOM Info Sets

5.N.8 HM&E, Electronic, and Weapon System and Equipment Info Sets• Descriptive Info Set • Functional Info Set• Maintenance Info Set• Operation Info Set• Operational checkout and troubleshooting

Info Set• System Equipment Installation Info Set

Go to NAVSEA S1000D Info Sets http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/NavyXMLSGMLRepository/DTDsSchemas/NAVSEAS1000DToolsReposito

ry.aspx




14

Gather Resources







Rules


CodeRegistration




15

Project Resources

BusinessRules9. Register Model

Identifier

7. Specify JS, DON, NAVSEA, Community, Project Business Rules

7.1 Determine

Model Identifier

7.2 Specify Metadata

requirements

7.3 Specify Data &

Formats for Deliverables

Gather Resources


Content


Requirements





What: Project level S1000D business rules address acquisition and development practices unique to Project level decision points.

Action: Development of business rules is a required activity as documented in the NAVSEA policy on the use of S1000D. The community of practice and project level business rules must be developed prior to acquisition from project decision points.

Explanation: Project level business rules result from the remaining undefined S1000D business rule decision points (BRDPs) that have not been defined by the higher level business rules (e.g., U.S. Joint Services and Department of Navy business rules).

Go to NAVSEA S1000D Business Rules http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/NavyXMLSGMLRepository/DTDsSchemas/NAVSEAS1000DToolsReposito

ry.aspx




16

Project Resources


CodeRegistration

9. Register Model Identifier

7. Specify JS, DON, NAVSEA, Community, Project Business Rules

7.1 Determine

Model Identifier

7.2 Specify Metadata

requirements

7.3 Specify Data &

Formats for Deliverables

Gather Resources


Content


Requirements





What: All projects must comply with S1000D by registering their model identification code (MI) with the NATO Support and Procurement Agency (NSPA), formerly NAMSA, located in Luxembourg.

Action: Projects must create their own MI according to S1000D. Projects will research the NSPA MOI/MI reference list at the NSPA website to determine if the MI exists. If the MI is already registered, the project must create a unique MI. If the MI does not exist, follow the NSPA registration instructions. For NAVSEA projects to complete the registration, notify NSWC Carderock of the new MI.

Explanation: Model identification code registration is an important step in the configuration between data and the supported system.

Go to NSPA Model Identification Code Registrationhttp://www.nspa.nato.int/en/organization/logistics/LogServ/asds2000m.htmDistribution Statement A: Approve for Public Release; distribution is unlimited



17

Gather Resources






Production Tools

QualityAssurance

andS1000DBREX



Activity QA

Authoring DMRL, DMC and ICN values, tagging

Delivery Proper packaging of DMs

Presentation Meeting the agreed functionality matrix


18

12. Specify QA

requirements

Production Tools

Quality Assurance andS1000D BREX

Gather Resources


Content


Requirements





What: Quality Assurance (QA) is a collection of DM and TM checking activities that ensure content meets form, fit and functional requirements. The S1000D BREX is one quality assurance tool used by NAVSEA for BR conformance.

Action: Authors link a project BREX specifying BRs to DMs. S1000D projects validate and verify TM content requirements through checking activities. NAVSEA maintains an S1000D BREX based on NAVSEA BRs.

Explanation: The Office of the Chief of Naval Operations (OPNAV) developed Navy-wide QA requirements for S1000D. TMCRs contain QA and S1000D BREX requirements.

Go to QA http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/S1000DInfoCenter/NAVSEAS1000DAcquisitionProcess.aspx

Go to NAVSEA BREXhttp://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/NavyXMLSGMLRepository/DTDsSchemas/NAVSEAS1000DToolsReposito

ry.aspxDistribution Statement A: Approve for Public Release; distribution is unlimited



19

Gather Resources






Production Tools


Tool )





20

16. Develop TMCR/TMSR

16.1 SMART-T

17. Issue Solicitation

What: Streamlined Modular Acquisition Requirements Tailoring-Tool (SMART-T) is an accurate and automated means for developing diverse NAVSEA TM requirements. Today, SMART-T supports S1000D Issue 4.0-based NAVSEA TM contract requirements

Action: NAVSEA Project managers use SMART-T to efficiently generate a TM Contract Requirements (TMCR) document used in a solicitation, a contract, a task order or a delivery order. Explanation: The NAVSEA technical data manager created SMART-T to output contract requirements for NAVSEA’s diverse systems from a single web-based tool. The NAVSEA TMMP, MIL-DTL-24784 and S1000D feed content to the TM contract requirements.

Gather Resources


Content


Requirements





Go to SMART-T (Requires DoD CAC card)

https://nsdsa.nmci.navy.mil/smartt/smarttv30.aspx

ProductionTools

SMART-T(TM Contract

Requirements Tool )




21

16. Develop TMCR/TMSR

16.1 SMART-T

17. Issue Solicitation

What: Data Item Descriptions (DIDs) contain the format and content preparation instructions for U.S. DOD data products. These data product deliverables support final TM development.

Action: The customer places DIDs on solicitations and contracts according to specific and discrete task requirements. Prior to developing TM content, authors submit DID data products to their customer for review and acceptance.

Explanation:DI-TMSS-81805 Data Module Requirements List (DMRL) S1000D DI-TMSS-81951 Project Business Rules (BRs) Decision TableDI-TMSS-81952 Project Business Rules (BRs) Exchange (BREX) FileDI-TMSS-81813A Technical Manual Book Plan DI-TMSS-81814A IETM Content Plan

Go to ASSISTdocs.com and search for the DIDs listed above

ProductionTools


Gather Resources


Content


Requirements







Produce Technical Manuals

22

Gather Resources






Project Resources


CSDB User

Manual

Production Tools CSDB Publishing

Engine

NAVSEATM

Viewer




48. Prepare TM package for Distribution

23

Project Resources

NAVSEA S1000D Tagging and Authoring

Guidelines

Gather Resources


Content


Requirements





What: Document Title - S1000D Issue 4.0.1 Tagging and Authoring Guidelines for Standard NAVSEA Integrated Publishing Process (SNIPP)

Action: Projects follow the tagging and authoring guidelines to develop and sustain technical manuals compliant with MIL-DTL-24784C content requirements structured and organized in the S1000D Issue 4.0.1 schemas. The NAVSEA S1000D Tagging and Authoring Guidelines influence NAVSEA, community of practice and project business rules.

Explanation: Main

Introduction Conventions usedAssistance and Feedback Reporting

Appendix A – Tagging Guidelines Lists schemas not covered in guide. Provides minimum DMs needed to produce a manual made of only “descript” DMs. Provides relationships between Schemas & TMs/Info Sets. References S1000D documentation.

Appendix B – Authoring GuidelinesFront and Rear Matter including Title Page or ScreenContent requirements for PDF and IETMs:

Publication ModulesData Modules and InfoSets

http://www.navsea.navy.mil/Portals/103/Documents/NSWC_Carderock/NAVSEA%20S1000D%20TAAG.pdf

Go to NAVSEA S1000D Tagging and Authoring GuideDistribution Statement A: Approve for Public Release; distribution is unlimited




24

Project Resources CSDB User Manual

Gather Resources


Content


Requirements





What: Document Title: Software User's Manual for Standard NAVSEA Integrated Publishing Process

Action: The NAVSEA CSDB user manual instructs authors how to obtain accounts, set-up TM projects, share DMs and PMs between projects, check-in and post projects, publish TMs and troubleshoot errors. NAVSEA maintains the user manual to document current and accurate CSDB functionality.

Explanation:

Go to CSDB User Manual (Requires DoD CAC Card)https://efs-east.deps.mil/Navy/seas1000d/Shared%20Documents/Forms/AllItems.aspx





25

Production Tools CSDB

Gather Resources


Content


Requirements





What: The CSDB is the information storage for collecting, managing and sharing S1000D objects in a project. It has been demonstrated that technical training content can be supported by DMs in a CSDB.

Action: NAVSEA encourages programs to use its centralized CSDB.Government sponsors must grant permission to the CSDB system administrator to establish CSDB user accounts.

Explanation: NAVSEA authorized and maintains an evolving enterprise CSDB.

Go to NAVSEA CSDBAccess Request

(Requires DoD CAC Card)https://nsdsa.nmci.navy.mil/smartt/smarttv30.aspxDistribution Statement A: Approve for Public Release; distribution is unlimited




26

Production Tools Publishing Engine

Gather Resources


Content


Requirements





What: The NAVSEA publishing engine transforms S1000D DMs into IETMs and PDFs for distribution to the TM supply system.

Action: The NAVSEA publisher produces technical documentation in formats and layouts specified by NAVSEA BRs and specifications. The publishing engine produces technical documentation that functions in the NAVSEA TM Viewer. The publishing engine supports the many NAVSEA system variants through the S1000D applicability model.

Explanation: NAVSEA authorized and maintains an evolving enterprise publishing engine.

Go to NAVSEA Publishing Enginehttps://navlogtd.navsses.navy.mil/





27

Production Tools

NAVSEATM Viewer

Gather Resources


Content


Requirements





What: The NAVSEA TM viewer displays S1000D IETMs in a consistent set of formats and functionalities. The TM viewer functionality requirements are documented in the NAVSEA IETM Viewer Software Performance Requirements.

Action: The NAVSEA TM Viewer CRB fields performance requirements from S1000D projects to advance viewer functionalities.

Explanation: The NAVSEA TM Viewer CRB has been authorized by NAVSEA headquarters to manage the NAVSEA TM Viewer program.

Go to NAVSEA TM Viewerhttp://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/NavyXMLSGMLRepository/DTDsSchemas/NAVSEAS1000DToolsRepository/NAVSEAViewerLiveContentStyleSkin.aspx



NAVSEA S1000D TOOL CHEST

Support Groups


Group



Board


NavyS1000D

InformationCenter

Website

TMManagement

Program Operations

and Procedures

NAVSEA S1000D

Acquisition and



Course(with S1000D)

NAVSEAS1000D

Info Sets


Rules


CodeRegistration


CSDB User

Manual



Production Tools


Tool )


QualityAssurance

andS1000DBREX

CSDB PublishingEngine

NAVSEATM

Viewer

28

Gather Resources








Thank You!

[email protected]@navy.mil

[email protected] (Phil)



Backup Slides


NAVSEA S1000D Tool Chest 31

What: The NAVSEA TM Viewer Configuration Review Board (CRB) establishes and manages performance requirements for a common TM viewer and convenes on an as-needed basis.

Action: Ensures that the TM viewer common look and feel complies with NAVSEA S1000D business rules and meets the NAVSEA IETM viewer software performance requirements. The CRB fosters the exchange of ideas on a common approach regarding the innovative display and functionality of NAVSEA IETMs.

Explanation: The Configuration Review Board received its authority from NAVSEA Headquarters, is chaired by NSWC Carderock, and is comprised of representatives from Navy Activities who are actively working S1000D and 24784C IETM issues..

Go to NAVSEA Viewer Change Requests for CRB

http://www.navsea.navy.mil/Home/WarfareCenters/NSWCCarderock/Resources/TechnicalInformationSystems/NavyXMLSGMLRepository/DTDsSchemas/NAVSEAS1000DToolsRepository/NAVSEAViewerLiveContentStyleSkin.aspx

Support Groups


Board


NAVSEA S1000D Tool Chest 32

What: A Data Module Requirements List (DMRL) creator is a spreadsheet that helps with the creation of the DMRL for a NAVSEA Project in accordance with DID DI-TMSS-81805 S1000D Data Module Requirements List.

Action: The DMRL is submitted to the Government for review and acceptance prior to the development of the TM and is used to initiate data module templates in the Navy’s Common Source Database (CSDB).

Explanation: The S1000D DMRL provides the Government program manager with a detailed overview of the proposed scope of the manual in compliance with the contract and applicable Technical Manual Contract Requirement (TMCR). The Government program manager also uses the DRML is used to track the status of data module development and delivery.

Go to the DMRL Creator (Requires DoD CAC Card)

https://efs-east.deps.mil/Navy/seas1000d/Shared%20Documents/Forms/AllItems.aspx

Project Resources DMRL Creator



Module 1 - TMMC CBT Course Introduction Module 2 - Introduction to NAVSEA TMMP Module 3 - Definition-TM Planning Module 4 - Definition-Budgeting, Funding, and Cost Estimating Module 5 - Definition-Procurement Module 6 - Development-TM Production & Records Management Module 7 - Development-TM Quality Assurance Module 8 - Development- TM Product Numbering Module 9 - Development-TM Acceptance and Certification

Module 10 - Development-TM Deficiency Program Module 11 - Distribution-TM Marking & Distribution Control Module 12 - Distribution-Distribution Requirements Definition Module 13 - Distribution-Initial Distribution Module 14 - Distribution-Navy Supply Requirements Module 15 - Disposal-TM Disposal

Gather Resources

33


NAVSEA TM Management Course

(with S1000D)

Gather Resources








Business Rules



What: A 15-part course providing NAVSEA TMMP principles.

Action: The NAVSEA TM Management Course (TMMC) is required for personnel assigned to perform TM management functions (see NAVSEAINST 4160.3B). The course is recommended for TM personnel in requesting activities, in program sponsor activities and in technical libraries. Explanation:

Go to TM Management Training (Requires DoD CAC card)

https://nsdsa.nmci.navy.mil/training/TMMC_CBT.aspxDistribution Statement A: Approve for Public Release; distribution is unlimited

NAVSEA S1000D Tool ChestDRAFT 34


NAVSEA S1000D Tool ChestDRAFT 35



AA

Compose Draft DMs/PMs

and/or IETMs

Gov’t Conducts Verification

Compose Preliminary DMs/

PMsand/or IETMs

Engineering Perform Desktop

Validation

Engineering Comments Resolved

Gov’t Comments Resolved

Final DM/PM/IETM Acceptance & Certification

Prepare TM package for Distribution

(SNIPP)

S1000D Technical Manual Development Process

Sheet 2 of 2

Load Accepted DMs/PMs/IETMs/

Graphics into Navy Designated CMS

Develop Work Flow for DM review and

approval process

At what point is data “registered”?

DRAFT 36Distribution Statement A: Approve for Public Release; distribution is unlimited