SlideShare a Scribd company logo
1 of 14
Download to read offline
© 2016 Aras aras.com
Technical Documentation
Kevin Richard, Product Manager
© 2016 Aras aras.com
Topics
 Solution Overview
▫ What are Technical Documents?
▫ Technical Documentation Challenges
▫ Aras Technical Documentation – Key Features
 Benefits
 Demo
 Q&A
© 2016 Aras aras.com3
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
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
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
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
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
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
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)
Content Publishing
© 2016 Aras aras.com11
Tech Document
Part
Query/
Filters
Tech Document
Part
User
Innovator
Part
Graphic
XML
HTML
PDF
 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
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
© 2016 Aras aras.com

More Related Content

What's hot

Rda step by step
Rda   step by stepRda   step by step
Rda step by step
Phani Kumar
 

What's hot (20)

FRSAD Functional Requirements for Subject Authority Data model
FRSAD Functional Requirements for Subject Authority Data modelFRSAD Functional Requirements for Subject Authority Data model
FRSAD Functional Requirements for Subject Authority Data model
 
Presentation on-hold-time-study
Presentation on-hold-time-studyPresentation on-hold-time-study
Presentation on-hold-time-study
 
Case study on change control in equipment
Case study on change control in equipmentCase study on change control in equipment
Case study on change control in equipment
 
Search Steragies and Refinement techniques.pptx
Search Steragies and Refinement techniques.pptxSearch Steragies and Refinement techniques.pptx
Search Steragies and Refinement techniques.pptx
 
Electronic batch manufacturing record
Electronic batch manufacturing recordElectronic batch manufacturing record
Electronic batch manufacturing record
 
Rda step by step
Rda   step by stepRda   step by step
Rda step by step
 
SharePoint Information Architecture Applied
SharePoint Information Architecture AppliedSharePoint Information Architecture Applied
SharePoint Information Architecture Applied
 
How to do a literature search?
How to do a literature search?How to do a literature search?
How to do a literature search?
 
Guide on how to write Result and Discussion.pptx
Guide on how to write Result and Discussion.pptxGuide on how to write Result and Discussion.pptx
Guide on how to write Result and Discussion.pptx
 
Elements of technical document
Elements of technical documentElements of technical document
Elements of technical document
 
Quality metrices
Quality metricesQuality metrices
Quality metrices
 
Coding for Declarative Customizations: How We Do It in Salesforce.com IT
Coding for Declarative Customizations: How We Do It in Salesforce.com ITCoding for Declarative Customizations: How We Do It in Salesforce.com IT
Coding for Declarative Customizations: How We Do It in Salesforce.com IT
 
Document & Data Control
Document & Data ControlDocument & Data Control
Document & Data Control
 
ALMA ANALYTICS internal training document IRAM - University of Western Australia
ALMA ANALYTICS internal training document IRAM - University of Western AustraliaALMA ANALYTICS internal training document IRAM - University of Western Australia
ALMA ANALYTICS internal training document IRAM - University of Western Australia
 
Document Development Life Cycle
Document Development Life CycleDocument Development Life Cycle
Document Development Life Cycle
 
Thesauri
ThesauriThesauri
Thesauri
 
SAP OpenText
SAP OpenTextSAP OpenText
SAP OpenText
 
An Overview of SAP S4/HANA
An Overview of SAP S4/HANAAn Overview of SAP S4/HANA
An Overview of SAP S4/HANA
 
Packaging, Labeling and Artwork Management
Packaging, Labeling and Artwork ManagementPackaging, Labeling and Artwork Management
Packaging, Labeling and Artwork Management
 
Research writing problems and solutions
Research writing problems and solutionsResearch writing problems and solutions
Research writing problems and solutions
 

Viewers also liked

Viewers also liked (7)

Technical document
Technical documentTechnical document
Technical document
 
Guidelines for technical writing documents
Guidelines for technical writing documentsGuidelines for technical writing documents
Guidelines for technical writing documents
 
How to Choose the Best Healthcare Analytics Software Solution in a Crowded Ma...
How to Choose the Best Healthcare Analytics Software Solution in a Crowded Ma...How to Choose the Best Healthcare Analytics Software Solution in a Crowded Ma...
How to Choose the Best Healthcare Analytics Software Solution in a Crowded Ma...
 
10 trends reshaping digital - updated Q1 2016
10 trends reshaping digital - updated Q1 201610 trends reshaping digital - updated Q1 2016
10 trends reshaping digital - updated Q1 2016
 
Common Technical Document
Common Technical DocumentCommon Technical Document
Common Technical Document
 
2016 Thumbtack Small Business Friendliness Survey
2016 Thumbtack Small Business Friendliness Survey2016 Thumbtack Small Business Friendliness Survey
2016 Thumbtack Small Business Friendliness Survey
 
The 8 Biggest Mistakes Social Media Marketers Make and How to Avoid Them
The 8 Biggest Mistakes Social Media Marketers Make and How to Avoid ThemThe 8 Biggest Mistakes Social Media Marketers Make and How to Avoid Them
The 8 Biggest Mistakes Social Media Marketers Make and How to Avoid Them
 

Similar to Technical Documentation for Technical Publications

CTE_corporate_overview
CTE_corporate_overviewCTE_corporate_overview
CTE_corporate_overview
Aniket Biswas
 

Similar to Technical Documentation for Technical Publications (20)

LavaCon 2017 - Much Ado About Templates: Reduce the Learning Curve and Increa...
LavaCon 2017 - Much Ado About Templates: Reduce the Learning Curve and Increa...LavaCon 2017 - Much Ado About Templates: Reduce the Learning Curve and Increa...
LavaCon 2017 - Much Ado About Templates: Reduce the Learning Curve and Increa...
 
CTE Overview Presentation
CTE Overview PresentationCTE Overview Presentation
CTE Overview Presentation
 
2013 Perforce Collaboration Tour - MathWorks
2013 Perforce Collaboration Tour - MathWorks2013 Perforce Collaboration Tour - MathWorks
2013 Perforce Collaboration Tour - MathWorks
 
Cloud Economics, from TCO to ROI
Cloud Economics, from TCO to ROICloud Economics, from TCO to ROI
Cloud Economics, from TCO to ROI
 
Understanding saa s
Understanding saa sUnderstanding saa s
Understanding saa s
 
Material declaration template design best practice
Material declaration template design best practiceMaterial declaration template design best practice
Material declaration template design best practice
 
Whats New from Aras 2016
Whats New from Aras 2016Whats New from Aras 2016
Whats New from Aras 2016
 
Toc08 Goldthwaite Digitizing Your Backlist
Toc08 Goldthwaite Digitizing Your BacklistToc08 Goldthwaite Digitizing Your Backlist
Toc08 Goldthwaite Digitizing Your Backlist
 
Parameters for c# developers.pdf
Parameters for c# developers.pdfParameters for c# developers.pdf
Parameters for c# developers.pdf
 
West Putting Structured Documents to Work
West Putting Structured Documents to WorkWest Putting Structured Documents to Work
West Putting Structured Documents to Work
 
CTE_corporate_overview
CTE_corporate_overviewCTE_corporate_overview
CTE_corporate_overview
 
Architecting Design Development Test Request System in Aras
Architecting Design Development Test Request System in ArasArchitecting Design Development Test Request System in Aras
Architecting Design Development Test Request System in Aras
 
20141109 Agile Dev East 2014 Conf Lean Documentation
20141109 Agile Dev East 2014 Conf Lean Documentation20141109 Agile Dev East 2014 Conf Lean Documentation
20141109 Agile Dev East 2014 Conf Lean Documentation
 
Techcello at a glance
Techcello at a glanceTechcello at a glance
Techcello at a glance
 
NAO Technical Discovery ITT National Audit Office
NAO Technical Discovery ITT National Audit OfficeNAO Technical Discovery ITT National Audit Office
NAO Technical Discovery ITT National Audit Office
 
Pre-Con Ed: CA Software Asset Management - Key Customer Topics
Pre-Con Ed: CA Software Asset Management - Key Customer TopicsPre-Con Ed: CA Software Asset Management - Key Customer Topics
Pre-Con Ed: CA Software Asset Management - Key Customer Topics
 
W7
W7W7
W7
 
Taming the Beast: Test/QA on Large-scale Projects
Taming the Beast: Test/QA on Large-scale ProjectsTaming the Beast: Test/QA on Large-scale Projects
Taming the Beast: Test/QA on Large-scale Projects
 
Case study : New SAP S/4HANA on SUSE Implementation Business Benefits Achieved
Case study : New SAP S/4HANA on SUSE Implementation Business Benefits AchievedCase study : New SAP S/4HANA on SUSE Implementation Business Benefits Achieved
Case study : New SAP S/4HANA on SUSE Implementation Business Benefits Achieved
 
Admin technology training nov 2007
Admin technology training   nov 2007Admin technology training   nov 2007
Admin technology training nov 2007
 

More from Aras

More from Aras (20)

Implementing PLM in the Fast-Paced, Innovation Driven Prepared Foods Industry
Implementing PLM in the Fast-Paced, Innovation Driven Prepared Foods IndustryImplementing PLM in the Fast-Paced, Innovation Driven Prepared Foods Industry
Implementing PLM in the Fast-Paced, Innovation Driven Prepared Foods Industry
 
Strategic BOM Management
Strategic BOM ManagementStrategic BOM Management
Strategic BOM Management
 
Client Technology Directions
Client Technology DirectionsClient Technology Directions
Client Technology Directions
 
Aras Vision and Roadmap 2016
Aras Vision and Roadmap 2016Aras Vision and Roadmap 2016
Aras Vision and Roadmap 2016
 
Aras Community Update 2016
Aras Community Update 2016Aras Community Update 2016
Aras Community Update 2016
 
MBSE and the Business of Engineering
MBSE and the Business of EngineeringMBSE and the Business of Engineering
MBSE and the Business of Engineering
 
Beyond ECAD Connectors
Beyond ECAD ConnectorsBeyond ECAD Connectors
Beyond ECAD Connectors
 
The PLM Journey of Justifying Change with Strategic Vision
The PLM Journey of Justifying Change with Strategic VisionThe PLM Journey of Justifying Change with Strategic Vision
The PLM Journey of Justifying Change with Strategic Vision
 
The Impact of IoT on Product Design
The Impact of IoT on Product DesignThe Impact of IoT on Product Design
The Impact of IoT on Product Design
 
Enterprise Agile Deployment
Enterprise Agile DeploymentEnterprise Agile Deployment
Enterprise Agile Deployment
 
Taking Manufacturing Process Planning to the Next Level
Taking Manufacturing Process Planning to the Next LevelTaking Manufacturing Process Planning to the Next Level
Taking Manufacturing Process Planning to the Next Level
 
Quality Systems
Quality SystemsQuality Systems
Quality Systems
 
Variant Management
Variant ManagementVariant Management
Variant Management
 
The Power of Self Service Reporting
The Power of Self Service ReportingThe Power of Self Service Reporting
The Power of Self Service Reporting
 
Making users More Productive with Enterprise Search
Making users More Productive with Enterprise SearchMaking users More Productive with Enterprise Search
Making users More Productive with Enterprise Search
 
Understanding the New Content Modeling Framework
Understanding the New Content Modeling FrameworkUnderstanding the New Content Modeling Framework
Understanding the New Content Modeling Framework
 
Supplier Exchange Portal
Supplier Exchange PortalSupplier Exchange Portal
Supplier Exchange Portal
 
Quality Planning for Product Risk Management
Quality Planning for Product Risk ManagementQuality Planning for Product Risk Management
Quality Planning for Product Risk Management
 
How to Configure Tech Docs
How to Configure Tech DocsHow to Configure Tech Docs
How to Configure Tech Docs
 
Techniques for Gathering Agile Requirements
Techniques for Gathering Agile RequirementsTechniques for Gathering Agile Requirements
Techniques for Gathering Agile Requirements
 

Recently uploaded

+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
?#DUbAI#??##{{(☎️+971_581248768%)**%*]'#abortion pills for sale in dubai@
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
vu2urc
 

Recently uploaded (20)

TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law DevelopmentsTrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 
Understanding Discord NSFW Servers A Guide for Responsible Users.pdf
Understanding Discord NSFW Servers A Guide for Responsible Users.pdfUnderstanding Discord NSFW Servers A Guide for Responsible Users.pdf
Understanding Discord NSFW Servers A Guide for Responsible Users.pdf
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?
 
Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdf
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)
 
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
 
presentation ICT roal in 21st century education
presentation ICT roal in 21st century educationpresentation ICT roal in 21st century education
presentation ICT roal in 21st century education
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 
Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 
Real Time Object Detection Using Open CV
Real Time Object Detection Using Open CVReal Time Object Detection Using Open CV
Real Time Object Detection Using Open CV
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of Terraform
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Tech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdfTech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdf
 
HTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation StrategiesHTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation Strategies
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
 
Developing An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of BrazilDeveloping An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of Brazil
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?
 

Technical Documentation for Technical Publications

  • 1. © 2016 Aras aras.com
  • 2. Technical Documentation Kevin Richard, Product Manager © 2016 Aras aras.com
  • 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. 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. 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. 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. 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. 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. 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. 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. Content Publishing © 2016 Aras aras.com11 Tech Document Part Query/ Filters Tech Document Part User Innovator Part Graphic XML HTML PDF
  • 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. 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. © 2016 Aras aras.com