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

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)IES Eladio Cabañero
 
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)Colin Habberton
 
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...Dogs Trust
 
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 LaraImprensa-semec
 
por sylvia jaque Hipotesis nula
 por sylvia jaque Hipotesis nula por sylvia jaque Hipotesis nula
por sylvia jaque Hipotesis nulasilviaseptiembre
 
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 PracticesDaniela Gachago
 
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çãoPortal Inovação UFMS
 
What the heck is eustress?
What the heck is eustress?What the heck is eustress?
What the heck is eustress?Lynette Crane
 
Organigrama 1
Organigrama 1Organigrama 1
Organigrama 1efsauba
 

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

Story boards and shot lists for my a level piece
Story boards and shot lists for my a level pieceStory boards and shot lists for my a level piece
Story boards and shot lists for my a level piececharlottematthew16
 
Vector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesVector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesZilliz
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
Training state-of-the-art general text embedding
Training state-of-the-art general text embeddingTraining state-of-the-art general text embedding
Training state-of-the-art general text embeddingZilliz
 
The Future of Software Development - Devin AI Innovative Approach.pdf
The Future of Software Development - Devin AI Innovative Approach.pdfThe Future of Software Development - Devin AI Innovative Approach.pdf
The Future of Software Development - Devin AI Innovative Approach.pdfSeasiaInfotech2
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostZilliz
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLScyllaDB
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxNavinnSomaal
 
Connect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationConnect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationSlibray Presentation
 
Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Commit University
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubKalema Edgar
 
Dev Dives: Streamline document processing with UiPath Studio Web
Dev Dives: Streamline document processing with UiPath Studio WebDev Dives: Streamline document processing with UiPath Studio Web
Dev Dives: Streamline document processing with UiPath Studio WebUiPathCommunity
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024Stephanie Beckett
 
AI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsAI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsMemoori
 
DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenHervé Boutemy
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clashcharlottematthew16
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupFlorian Wilhelm
 
Scanning the Internet for External Cloud Exposures via SSL Certs
Scanning the Internet for External Cloud Exposures via SSL CertsScanning the Internet for External Cloud Exposures via SSL Certs
Scanning the Internet for External Cloud Exposures via SSL CertsRizwan Syed
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationRidwan Fadjar
 

Kürzlich hochgeladen (20)

Story boards and shot lists for my a level piece
Story boards and shot lists for my a level pieceStory boards and shot lists for my a level piece
Story boards and shot lists for my a level piece
 
Vector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector DatabasesVector Databases 101 - An introduction to the world of Vector Databases
Vector Databases 101 - An introduction to the world of Vector Databases
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
Training state-of-the-art general text embedding
Training state-of-the-art general text embeddingTraining state-of-the-art general text embedding
Training state-of-the-art general text embedding
 
The Future of Software Development - Devin AI Innovative Approach.pdf
The Future of Software Development - Devin AI Innovative Approach.pdfThe Future of Software Development - Devin AI Innovative Approach.pdf
The Future of Software Development - Devin AI Innovative Approach.pdf
 
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage CostLeverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
Leverage Zilliz Serverless - Up to 50X Saving for Your Vector Storage Cost
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQL
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptx
 
Connect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationConnect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck Presentation
 
Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding Club
 
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptxE-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
 
Dev Dives: Streamline document processing with UiPath Studio Web
Dev Dives: Streamline document processing with UiPath Studio WebDev Dives: Streamline document processing with UiPath Studio Web
Dev Dives: Streamline document processing with UiPath Studio Web
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024
 
AI as an Interface for Commercial Buildings
AI as an Interface for Commercial BuildingsAI as an Interface for Commercial Buildings
AI as an Interface for Commercial Buildings
 
DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache Maven
 
Powerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time ClashPowerpoint exploring the locations used in television show Time Clash
Powerpoint exploring the locations used in television show Time Clash
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project Setup
 
Scanning the Internet for External Cloud Exposures via SSL Certs
Scanning the Internet for External Cloud Exposures via SSL CertsScanning the Internet for External Cloud Exposures via SSL Certs
Scanning the Internet for External Cloud Exposures via SSL Certs
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 Presentation
 

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.