16
Arbortext for S1000D Curriculum Guide

ASD S1000D Specification — Fundamental Concepts

Embed Size (px)

Citation preview

Arbortext for S1000D

Curriculum Guide

Live Classroom Curriculum Guide

ASD S1000D Specification

S1000D Module for Windchill Service Information Manager 10.2 for

Authors and Administrators

ASD S1000D Specification

Course Code TRN-2374-T

Course Length 2 Days

Overview

In this two-day course, students will learn the fundamental concepts of the ASD S1000D Specification. The ASD S1000D Specification course is intended for users familiar with producing technical publications, but who are new to the ASD S1000D Specification. The first course section provides an overview of ASD S1000D Specification terminology and reviews the concepts required to understand user roles and tasks in an ASD S1000D Specification workflow. The second course section provides relevant concepts needed to understand the planning, implementation, and production of Business Rules and Publications in the context of ASD S1000D Specification workflow. Finally, the third course section provides an overview of ASD S1000D Specification administration concepts necessary to understand the administrative tasks required in the ASD S1000D Specification workflow. Collectively, this training will help users work within and administrators deploy the Arbortext for Aerospace and Defense software suite.

Prerequisites

Some knowledge of Technical Publications processes.

Basic familiarity with structured authoring concepts and a general familiarity with XML.

Audience

ASD S1000D Administrators, Super Users, and Publications Administrators

ASD S1000D Authors

ASD S1000D Reviewers, Illustrators, and Users

Topics

Summarize the background and purpose of the ASD S1000D Specification in the Aerospace and Defense community.

Identify and describe ASD S1000D Specification fundamental concepts and vocabulary.

Identify and describe differences between ASD S1000D Specification Data Module Types.

Identify and describe the construction of ASD S1000D Specification Data Module Codes.

Identify and describe the construction of ASD S1000D Specification Information Control Numbers.

Identify and describe the function of the ASD S1000D Specification Applicability concept.

Identify and describe the components of an ASD S1000D Specification-compliant Interactive Electronic Technical Publication (IETP).

Identify and describe the components of the ASD S1000D Specification workflow.

Identify and describe the purpose of the ASD Simplified Technical English (ASD-STE100) standard in context of ASD S1000D compliant technical publications.

Summarize and discuss the benefits of applying the ASD S1000D Specification as part of the product development technical publications and documentation workflow.

Identify and distinguish the differences between various ASD S1000D Specification compliant Information Sets and Publications.

List and describe the important concepts and components creating and working with Business Rules in the context of an ASD S1000D Specification compliant project.

List and describe the integration points between existing ILS systems and an ASD S1000D Specification compliant production system.

Describe ASD S1000D Data Interchange concepts.

List at least two ways an ASD S1000D Specification project may be tailored.

List and describe potential integration points between existing ILS systems and an ASD S1000D CSDB.

Describe the main differences between Issue 3 and Issue 4 of the ASD S1000D Specification.

List the responsibilities of an ASD S1000D Specification CSDB Administrator.

Agenda

Day 1

Module 1 The Arbortext Aerospace and Defense Product Solution

Module 2 Introduction to the ASD S1000D Specification: Background and Benefits

Module 3 ASD S1000D Specification Process, Chapters, and Concepts

Module 4 ASD S1000D Specification Interactive Electronic Technical Manuals/Publications

Module 5 ASD S1000D Specification Applicability

Day 2

Module 6 ASD S1000D Specification Technical Repository

Module 7 ASD S1000D Specification Container alternate

Module 8 ASD S1000D Specification Workflow Process

Module 9 ASD S1000D Specification and ASD-STE100 (Simplified Technical English)

Module 10 ASD S1000D Specification Information Sets and Publication Modules

Module 11 ASD S1000D Specification Business Rules

Module 12 ASD S1000D Specification Data Interchange Concepts

Module 13 Tailoring an ASD S1000D Specification Project

Module 14 The ASD S1000D Specification and Integrated Logistics Support Systems

Module 15 What’s New in the ASD S1000D Specification

S1000D Module for Windchill Service Information Manager 10.2 for Authors and Administrators

Overview

Course Code TRN-2375-T

Course Length 2 Days

The PTC Windchill Service Information Manager - S1000D Module solution has ‘role based’ interfaces. This class covers the use of the Product Manager role, typically the person who sets up and administers an S1000D product. This class is instructor led, hands on training that shows you how to use this interface to the PTC Windchill Service Information Manager for S1000D module using practical exercises.

Course Objectives

Operate the SIM for S1000D module in a production environment.

Set up and maintain S1000D products. Understand the basic concepts of creating,

managing, and delivering content in Windchill Service Information Manager – S1000D.

Identify programs which can be integrated with the SIM for S1000D module.

Understand the relevance of Arbortext Editor, Styler, and Publishing Engine for S1000D.

Set up security and user roles. Create new products. Assign participants. Add the business rules data module (BREX)

and assign it to a product. Add SNS nodes and update node attributes. Identify the uses of information control

numbers (ICN), including model identification code ICNs and CAGE code-based ICNs.

Create CAGE-based ICN nodes. Populate the common source database

(CSDB). Add data to products. Allocate users and release for authoring. Remove/insert existing data modules.

Edit and produce data. Understand workflow steps within the

S1000D solution. Manage S1000D change requests. Raise a data module or information control

number (ICN) in issue. Create publications. Add content to publication structures. Publish to PDF. Import and export data.

Prerequisites

Basic understanding of Windchill (T4260 - Introduction to Windchill PDMLink 10.2 for Light Users or WBT-4401-0 - Locate and View Information with Windchill Service Information Manager 10.2)

Working knowledge of XML (T2270 - Introduction to XML, DITA and Arbortext) Understanding of the S1000D Specification (T2374 - ASD S1000D Specification) Familiarity with the Arbortext structured authoring tool (T4410 - Authoring using Arbortext Editor 6.1)

Audience

ASD S1000D Specification compliant content authors and reviewers ASD S1000D Specification compliant Project Administrators, Publishing Administrators, and System

Administrators

Agenda

Day 1

Module 1 Solution Architecture Overview

Module 2 Product Setup

Module 3 Product Configuration

Module 4 Requirements Management and Data Production

Day 2

Module 5 Editing

Module 6 Review Cycle and Change Requests

Module 7 Publication Structure Creation

Module 8 Data Interchange

Web Based Curriculum Guide

ASD S1000D Specification - Fundamental Concepts

ASD S1000D Specification - Business Rules and Publication Concepts

ASD S1000D Specification - Administration Concepts

Arbortext CSDB 4.3 for S1000D Issue 4 (for Authors)

ASD S1000D Specification — Fundamental ConceptsOverview

Course Code WBT-2370-0

Course Length 8 Hours

In this one-day course, students will learn the fundamental concepts of the ASD S1000DSpecification. The ASD S1000D Specification Fundamental Concepts course is intended for usersfamiliar with producing technical publications, but who are new to the ASD S1000D Specification.The course provides an overview of the ASD S1000D Specification vocabulary and conceptsnecessary to understand user roles and required tasks in an ASD S1000D Specification workflowusing the Arbortext for Aerospace and Defense software suite.

Course Objectives

• Summarize the background and purpose of the ASD S1000D Specification in the Aerospace andDefense community.

• Identify and describe ASD S1000D Specification fundamental concepts and vocabulary.• Identify and describe differences between ASD S1000D Specification Data Module Types.• Identify and describe the construction of ASD S1000D Specification Data Module Codes.• Identify and describe the construction of ASD S1000D Specification Information Control Numbers.• Identify and describe the function of the ASD S1000D Specification Applicability concept.• Identify and describe the components of an ASD S1000D Specification-compliant Interactive

Electronic Technical Publication (IETP).• Identify and describe the components of the ASD S1000D Specification workflow.• Identify and describe the purpose of the ASD Simplified Technical English (ASD-STE100) standard

in context of ASD S1000D compliant technical publications.

Prerequisites

• Some knowledge of Technical Publications processes.

• Basic familiarity with structured authoring concepts and a general familiarity with XML.

Audience

• ASD S1000D Administrators, Super Users, and Publications Administrators

• ASD S1000D Authors

• ASD S1000D Reviewers, Illustrators, and Users

ASD S1000D Specification — Business Rules and PublicationConceptsOverview

In this four-hour course, students will learn ASD S1000D Specification Business Rules andPublication concepts . The ASD S1000D Specification — Business Rules and PublicationConcepts course is intended for users familiar with producing technical publications, but who arenew to the ASD S1000D Specification. The course provides an overview of the ASD S1000DSpecification vocabulary and concepts relevant to the planning, implementation, and production ofBusiness Rules and Publications, in the context of ASD S1000D Specification workflow, using theArbortext for Aerospace and Defense software suite.

Course Objectives

• Summarize and discuss the benefits of applying the ASD S1000D Specification as part of theproduct development technical publications and documentation workflow.

• Identify and distinguish the differences between various ASD S1000D Specification compliantInformation Sets and Publications.

• List and describe the important concepts and components creating and working with BusinessRules in the context of an ASD S1000D Specification compliant project.

• List and describe the integration points between existing ILS systems and an ASD S1000DSpecification compliant production system.

Prerequisites

• Some knowledge of Technical Publications processes.

• Basic familiarity with structured authoring concepts and a general familiarity with XML.

• PTCU TRN–2370 ASD S1000D Specification — Fundamental Concepts

Audience

• ASD S1000D Administrators, Super Users, and Publications Administrators

• ASD S1000D Authors

• ASD S1000D Reviewers

Course Code WBT-2371-0

Course Length 8 Hours

Table of ContentsModule 1 ASD S1000D Specification Information Sets and Publication Modules

Module 2 ASD S1000D Specification Business Rules

Module 3 ASD S1000D Specification Glossary of Acronyms

ASD S1000D Specification — Administration ConceptsOverview

Course Code WBT-2372-0

Course Length 4 Hours

In this four–hour course, students will learn administration concepts of the ASD S1000DSpecification. The ASD S1000D Specification — Administration Concepts course is intended fortechnical publications department super users, publication administrators, and system administratorswho are new to the ASD S1000D Specification. The course provides an overview of the ASDS1000D Specification administration concepts vocabulary and concepts necessary to understanduser roles and administrative tasks in the context of an ASD S1000D Specification workflow usingthe Arbortext for Aerospace and Defense software suite.

Course Objectives

• Describe ASD S1000D Data Interchange concepts.• List at least two ways an ASD S1000D Specification project may be tailored.• List and describe potential integration points between existing ILS systems and an ASD S1000D

CSDB.• Describe the main differences between Issue 3 and Issue 4 of the ASD S1000D Specification.• List the responsibilities of an ASD S1000D Specification CSDB Administrator.

Prerequisites

• Some knowledge of Technical Publications processes.

• Basic familiarity with structured authoring concepts and a general familiarity with XML.

• PTCU TRN–2370 ASD S1000D Specification — Fundamental Concepts, PTCU TRN-2371 ASDS1000D Specification — Business Rules and Publication Concepts

Audience

• ASD S1000D Administrators, Super Users, and Publications Administrators

Table of ContentsModule 1 ASD S1000D Specification Data Interchange Concepts

Module 2 Tailoring an ASD S1000D Specification Project

Module 3 The ASD S1000D Specification and Integrated Logistics Support Systems

Module 4 What’s New in the ASD S1000D Specification

Module 5 ASD S1000D Specification Glossary of Acronyms

Arbortext CSDB 4.3 for S1000D Issue 4 (for Authors)Overview

Course Code WBT-2373-0

Course Length 8 Hours

The PTC S1000D solution has ‘role based’ interfaces. This class covers the use of the CSDBAuthor Role, typically the person who creates S1000D data modules and request illustrations fromthe illustrators.This person can also be a reviewer, and is responsible for creation/validation of content.This class is instructor led, hands on training that shows you how to use this interface to the CSDBusing practical exercises.

Course Objectives

• Describe the Common Source Database (CSDB) and how it fits in with the publishing system.• Setup the Arbortext Editor Interface with the Arbortext CSDB.• Use the CSDB Task Client to manage ASD S1000D Specification documents.• Use Arbortext Editor to create basic ASD S1000D Specification compliant content.

Prerequisites

• PTCU — Understanding SGML and XML

• PTCU — Introduction to the ASD S1000D Specification

• PTCU — Authoring Using Arbortext Editor

Audience

• ASD S1000D Specification compliant content authors and reviewers.

• ASD S1000D Specification compliant Project Administrators, Publishing Administrators, and SystemAdministrators

Table of ContentsModule 1 The Arbortext Aerospace and Defense Product Solution

Module 2 CSDB Basics

Module 3 System Setup

Module 4 Authoring and Review Workflow

Module 5 Authoring Editor - Authoring Interface

Module 6 Basic Authoring Tasks

Module 7 CSDB - Task Station Processes

Module 8 Data Module Validation, Review, and Entity Production Control

Module 9 ASD S1000D Specification Glossary of Acronyms