Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Technical Documentation for Technical Publications

1,055 views

Published on

Presenter: Kevin Richard, Aras
Technical Documentation is a revolutionary approach to creating product-related documents such as user manuals, training documents, and marketing datasheets. Come see it in action and discuss the benefits to your organization.

Published in: Technology
  • Be the first to comment

Technical Documentation for Technical Publications

  1. 1. © 2016 Aras aras.com
  2. 2. Technical Documentation Kevin Richard, Product Manager © 2016 Aras aras.com
  3. 3. Topics  Solution Overview ▫ What are Technical Documents? ▫ Technical Documentation Challenges ▫ Aras Technical Documentation – Key Features  Benefits  Demo  Q&A © 2016 Aras aras.com3
  4. 4. Technical Documentation  Examples  User / System Manuals  Training Material / Help Documentation  Work Instructions  Part Specifications / Catalogs  Typically feature information about products  Have well-defined structure  Increasing trend to consume electronically  Topics-based / modular © 2016 Aras aras.com4
  5. 5. Challenges of Technical Documentation  Ensuring documents are accurate and complete ▫ Regulatory/safety/commercial pressures  Synchronization with documents as products evolve  Version/Change management ▫ Managing changes between variants  Maintaining consistency (content and style) ▫ Applying changes to existing documents © 2016 Aras aras.com5
  6. 6. A New Approach  PLM-based Document Authoring Environment ▫ Leverage Aras Innovator’s core functionality ▫ Web-based, no client installs ▫ Embed / reference content from managed Business Items  Extensible document schema framework  Extensible document style configuration  Publishing framework with support for XML, HTML, and PDF © 2016 Aras aras.com6
  7. 7. Structured Content © 2016 Aras aras.com7 Tech Document Title Sub Title Description Graphic Overview Features List Components Part Reference Document Schema Defined by a Data Schema, which controls: ▫ Types of document content ▫ Required vs Optional elements ▫ Cardinality  Enables: ▫ Compliance to company Standards ▫ Consistency Required Optional
  8. 8. Tech Document Integrating with Business Items in PLM © 2016 Aras aras.com8  Include both new content and reuse of existing content  Revision information is maintained with the document Graphic Graphic Graphic Part Catalog Entry Rev A Catalog Entry Catalog Entry Catalog Entry
  9. 9. Tech Document Managing Change © 2016 Aras aras.com9  Change in referenced content may drive change to associated documents ▫ As referenced content evolves, Authors can update documents individually, or in batch Graphic Graphic Graphic Part Catalog Entry Rev A Catalog Entry Catalog Entry Catalog Entry Catalog Entry Rev B
  10. 10. Enabling Document Variability © 2016 Aras aras.com10  Use Options to characterize documents and document content ▫ Provides a filter  User-defined  Applied to documents and referenced content Tech Document Parking Brake Lever Disassembly 1. Remove the floor console 2. Remove the rear air duct 3. Loosen the adjustment and unhook the wires 4. Remove the bracket from the console 5. Mark the position of the front nut 6. Remove the bolts and nuts that hold the lever mechanism. Lift out the mechanism 1. Remove the floor console 2. Remove the rear air duct Model: 9-3 * 2. Remove the rear air ductModel: 9-3 (9440)
  11. 11. Content Publishing © 2016 Aras aras.com11 Tech Document Part Query/ Filters Tech Document Part User Innovator Part Graphic XML HTML PDF
  12. 12.  Improved accuracy and completeness ▫ Embed / reference content from managed objects in PLM  Ex. Parts, Operations, Graphics  Version management ▫ Change Notification, etc.  Meet regulatory requirements ▫ Enforce standard content and layout via schema  Increased authoring productivity ▫ Structured: Ensures consistency ▫ Modular / Topic-based: Enables reuse  Secure ▫ Access Control managed by Workflow/Lifecycle © 2016 Aras 12 Benefits aras.com
  13. 13. Product Availability  Technical Documentation 11 R1 Released Dec. ’15 ▫ Open to Community  Subscribers get Export/Publishing capability ▫ Installation via new Aras Update Application  New for SP5 Applications and Beyond…  http://www.aras.com/support/downloads/download.aspx © 2015 Aras aras.com13
  14. 14. © 2016 Aras aras.com

×