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.

Getting Your Technical Documentation Right

201 views

Published on

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

Published in: Technology, Business
  • Be the first to comment

Getting Your Technical Documentation Right

  1. 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. 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. 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. 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. 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.

×