Technical Document Authoring and

Transcription

1 2015 Aras 1

2 Technical Document Authoring and Management in PLM Kevin Richard 2015 Aras 2

3 Agenda Business Justification (Challenges/Goals) Technical Documents Features Demo Wrap up and questions 2015 Aras 3

4 Challenges of Technical Documentation Synchronization with documents as products evolve Version/Change management Managing changes between variants Extracting business intelligence from corpus of technical documentation Maintaining consistency (content and style) Applying changes to existing documents 2015 Aras 4

5 Goals Create a PLM Technical Document Authoring Environment Web-based Leverage Aras Innovator s core functionality Access Control, Change Management, Workflow/Lifecycle, Relationships, etc. Provide a mechanism to embed / reference content from managed Business Items Track connectivity and changes to revision-controlled elements Define an extensible document schema framework Explicit definition of document structure and tools to validate and direct the authoring process Create a publishing framework with support for XML, HTML, and PDF 2015 Aras 5

6 Technical Documentation Typically feature information about products Have well-defined structure Increasing trend to consume electronically Topics-based / Modular Examples User / System Manuals Training Material / Help Documentation Work Instructions Specifications/Catalogs 2015 Aras 6

7 Structured Content Aras Tech Docs: Defined by a Data Schema, which controls: Types of document content Required vs Optional elements Cardinality Enables: Compliance to company Standards Consistency Description text content Features Feature description A Feature description B Feature description C Components Assembly Component Table Dimensions Tech Document Title Sub-title Document Schema Title Sub Title Overview Description Graphic Features List Components Reference Dimensions 2015 Aras 7

8 Integrating with Business Items in PLM Aras Tech Docs: Include both new content and reuse of existing content Version information is maintained with the document Description text content Features Feature description A Feature description B Feature description C Components Assembly Component Table Tech Document Title Sub-title Graphic Rev A Dimensions Referenced document content Tech Document 2015 Aras 8

9 Managing Change Change in referenced content may drive change to associated documents As referenced content evolves, Authors can update documents individually, or in batch Description text content Features Feature description A Feature description B Feature description C Components Assembly Component Table Tech Document Title Sub-title Graphic Rev BA Dimensions Referenced document content Tech Document 2015 Aras 9

10 Enabling Product Variability Aras Tech Docs: Use Options to characterize documents and document content Provides a filter User-defined Applied to documents and referenced content Description text content Features Feature description A Feature description B Feature description C Components Assembly Component Table Tech Document Title Sub-title Model: #X Model: #X Features Feature description A Feature description B Feature description C Feature description D Dimensions 2015 Aras 10

11 Content Publishing Innovator XML Transform <XML/> Customers/ Suppliers MakerBot - Extruder Fan Assembly User <XML/> PDF Generation Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Features Item 1 Item 2 Item 3 Components Marketing Query/ Filters Tech Document Tech Document Graphics Graphic HTML Generation Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Company Website 2015 Aras 11

12 Document Editor Features Structure Tree Content Editor Structure Tree Document Element hierarchy WYSIWYG Content Editor Formatted Text 2D Graphics Lists, Tables, Hyperlinks Options Editor and filter 2015 Aras 12

13 Document Editor Demonstration 2015 Aras 13

14 Aras Technical Documents Document Content Structured: Ensures consistency Modular / Topic-based: Enables reuse Embed / reference content from managed objects in PLM Ex. s, Operations, Graphics Leverage Innovator s core PLM Functionality Access Control, Workflow/Lifecycle, Change Notification, etc. Target Release : Q Aras 14

15 Questions? 2015 Aras 15

16 2015 Aras 16