Saturday, July 18, 2009

Technical Documents

Technical Writing involves creating a wide range of documents that varies across organizations. These documents are created using various tools like MS Office, FrameMaker, RoboHelp, Adobe Creative Suite comprising of Photoshop, InDesign, Flash, and so on. Some of these technical documents are:

  1. User’s Guide: Companies that offers products or services need to have user guides to explain how to use the product/service. The Guide contains detailed description of product/service features and instructions to use them.
  2. Online Help: The growth in online media has popularized creation of Online Help by companies. The Help provide assistance on using a particular product/service.
  3. Installation, Reference and Troubleshooting Guide: Companies needs to familiarize the users how to install or repair their product or software. This document provides steps to install and troubleshoot the product or software.
  4. Release Notes: Companies create Release Notes to familiarize the users with new features, enhancements, fixed issues and known issues of the product or software. These are publications distributed along with product in the development or test state. These are also created every time a bug is fixed or an enhancement is made on the product.
  5. Technical Advisory: This document describes an issue, its cause and work around.
  6. Marketing Collaterals: Companies create marketing or sales document to market and promote their product or services. Common examples of marketing collaterals are business proposals, white papers, datasheets, sales brochures, flyers, catalogs, posters, and presentations.
  7. Training Materials: Companies require training their employees or external customers. These are publications created for use in self-paced training or classroom environment. Common examples are tutorials, workbooks and instructor’s guide.
  8. Miscellaneous: Occasionally, companies need other type of writing intended for publication done for them. For example, documents like newsletters, technical reports, resume, press releases, etc. are created by technical writers.

1 comment:

gayathri vishwanathan said...

Good information...thanks :)