SlideShare ist ein Scribd-Unternehmen logo
1 von 5
Getting Your Technical Documentation Right 

The Objective of technical documents is to preserve and reuse contents any time requested.
This is required at the following millstones of the life cycle of the product or a system.

The following matrix lists the document types used at each millstone.
Milestones of Product Life Cycle P1

Document Type

Document Type

Document Type

Design review
CAD drawings

Assembly instructions
BOM lists

Historic design review
Acceptance tests
Field/ Clinical review

Audience

Audience

Management

Management

Responsibility

Responsibility

Engineering Team

Engineering Team
Production Team

Development

Production

Audience

Management
Regulator
Buyer

Regulatory Issues
Milestones of Product Life Cycle P2

Document Type

Document Type

Document Type

Guides & training Kits

Installation &
Maintenance guides

Online Help
Offline Help

Audience

Audience

User

User

Responsibility

Responsibility

Technical Writer

Support personal
Help desk

Audience

User
Responsibility

Technical Writer
Instruction Designer
User Assistance

Installation &
Maintenance

Customer Support
Content Sharing
Research shows that the same data is accessed at various millstones during a product’s life cycle.
In order to share these data and make it available to all the stakeholders a content management
system is required.
Integration between content management systems, engineering data and publication
applications is a key issue for an appropriate document management approach.

Engineering
Data
January

February

March

April

Content
Management
Systems

May

Publication
Applications

Document
Management

June
Summary

• Documentation and content management is a long term strategic project
and not intended to address and solve temporary problems.
• Sharing and publishing content is a key issue which has to be done right.
• If you are interested in practical solutions to implement content
management systems at you organization, please contact us
• 972(4)8336435 or visit www.technicalcom.co.il.

Weitere ähnliche Inhalte

Andere mochten auch

Ficha de inscrição Oficina teatro Valter Lara
Ficha de inscrição Oficina teatro Valter LaraFicha de inscrição Oficina teatro Valter Lara
Ficha de inscrição Oficina teatro Valter Lara
Imprensa-semec
 
por sylvia jaque Hipotesis nula
 por sylvia jaque Hipotesis nula por sylvia jaque Hipotesis nula
por sylvia jaque Hipotesis nula
silviaseptiembre
 
Organigrama 1
Organigrama 1Organigrama 1
Organigrama 1
efsauba
 

Andere mochten auch (12)

Bangladesh health network
Bangladesh health networkBangladesh health network
Bangladesh health network
 
Normas de Convivencia IES Eladio Cabañero (Rev. 2013)
Normas de Convivencia IES Eladio Cabañero (Rev. 2013)Normas de Convivencia IES Eladio Cabañero (Rev. 2013)
Normas de Convivencia IES Eladio Cabañero (Rev. 2013)
 
Connecting Capital to Sustainability: SSD Conference 2013 (US)
Connecting Capital to Sustainability: SSD Conference 2013 (US)Connecting Capital to Sustainability: SSD Conference 2013 (US)
Connecting Capital to Sustainability: SSD Conference 2013 (US)
 
культурні столиці європи
культурні столиці європикультурні столиці європи
культурні столиці європи
 
ICAWC 2013 - Creation of an Oasis for Companion Animals in a Barren Place - J...
ICAWC 2013 - Creation of an Oasis for Companion Animals in a Barren Place - J...ICAWC 2013 - Creation of an Oasis for Companion Animals in a Barren Place - J...
ICAWC 2013 - Creation of an Oasis for Companion Animals in a Barren Place - J...
 
Ficha de inscrição Oficina teatro Valter Lara
Ficha de inscrição Oficina teatro Valter LaraFicha de inscrição Oficina teatro Valter Lara
Ficha de inscrição Oficina teatro Valter Lara
 
por sylvia jaque Hipotesis nula
 por sylvia jaque Hipotesis nula por sylvia jaque Hipotesis nula
por sylvia jaque Hipotesis nula
 
telematica
telematicatelematica
telematica
 
Emerging technologies and Changing Teaching and Learning Practices
Emerging technologies and Changing Teaching and Learning PracticesEmerging technologies and Changing Teaching and Learning Practices
Emerging technologies and Changing Teaching and Learning Practices
 
Apresentação FNQ Encontro de Inovação
Apresentação FNQ Encontro de InovaçãoApresentação FNQ Encontro de Inovação
Apresentação FNQ Encontro de Inovação
 
What the heck is eustress?
What the heck is eustress?What the heck is eustress?
What the heck is eustress?
 
Organigrama 1
Organigrama 1Organigrama 1
Organigrama 1
 

Kürzlich hochgeladen

IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI Solutions
Enterprise Knowledge
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Service
giselly40
 

Kürzlich hochgeladen (20)

From Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationFrom Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
 
08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men
 
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
 
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...
 
The Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxThe Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptx
 
The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processors
 
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI Solutions
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt Robison
 
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?
 
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?
 
The Role of Taxonomy and Ontology in Semantic Layers - Heather Hedden.pdf
The Role of Taxonomy and Ontology in Semantic Layers - Heather Hedden.pdfThe Role of Taxonomy and Ontology in Semantic Layers - Heather Hedden.pdf
The Role of Taxonomy and Ontology in Semantic Layers - Heather Hedden.pdf
 
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
 
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day PresentationGenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day Presentation
 
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
 
Advantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessAdvantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your Business
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Service
 
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
Bajaj Allianz Life Insurance Company - Insurer Innovation Award 2024
 

Getting Your Technical Documentation Right

  • 1. Getting Your Technical Documentation Right  The Objective of technical documents is to preserve and reuse contents any time requested. This is required at the following millstones of the life cycle of the product or a system. The following matrix lists the document types used at each millstone.
  • 2. Milestones of Product Life Cycle P1 Document Type Document Type Document Type Design review CAD drawings Assembly instructions BOM lists Historic design review Acceptance tests Field/ Clinical review Audience Audience Management Management Responsibility Responsibility Engineering Team Engineering Team Production Team Development Production Audience Management Regulator Buyer Regulatory Issues
  • 3. Milestones of Product Life Cycle P2 Document Type Document Type Document Type Guides & training Kits Installation & Maintenance guides Online Help Offline Help Audience Audience User User Responsibility Responsibility Technical Writer Support personal Help desk Audience User Responsibility Technical Writer Instruction Designer User Assistance Installation & Maintenance Customer Support
  • 4. Content Sharing Research shows that the same data is accessed at various millstones during a product’s life cycle. In order to share these data and make it available to all the stakeholders a content management system is required. Integration between content management systems, engineering data and publication applications is a key issue for an appropriate document management approach. Engineering Data January February March April Content Management Systems May Publication Applications Document Management June
  • 5. Summary • Documentation and content management is a long term strategic project and not intended to address and solve temporary problems. • Sharing and publishing content is a key issue which has to be done right. • If you are interested in practical solutions to implement content management systems at you organization, please contact us • 972(4)8336435 or visit www.technicalcom.co.il.