getting your technical documentation right
TRANSCRIPT
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.
Getting Your Technical Documentation Right
The following matrix lists the document types used at each millstone.
Development Production Regulatory Issues
Milestones of Product Life Cycle P1
Document Type
Design reviewCAD drawings
Audience
Management
Responsibility
Engineering Team
Document Type
Assembly instructionsBOM lists
Audience
Management
Responsibility
Engineering TeamProduction Team
Document Type
Historic design reviewAcceptance testsField/ Clinical review
Audience
ManagementRegulatorBuyer
User AssistanceInstallation & Maintenance
Customer Support
Milestones of Product Life Cycle P2
Document Type
Guides & training Kits
Audience
User
Responsibility
Technical WriterInstruction Designer
Document Type
Installation & Maintenance guides
Audience
User
Responsibility
Technical Writer
Document Type
Online HelpOffline Help
Audience
User
Responsibility
Support personalHelp desk
February March April MayJanuary
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.
June
Content Sharing
Document Management
Content Management
Systems
Engineering Data
Publication Applications
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.