Software Documentation

Technical and User Documentation

User Manual/Guide: It is a guide that contains introduction of the product or software, how to use it, context about the interface, what the controls mean etc.

Hardware Manual: It is a guide for how the working of a physical existing product can be handled. Giving a procedural guide with images to make the user understand the hardware.

Software Manual: This guide is for giving the instructions to the user about installing a software, how to initialize it, how to use it, what steps to take out a required result and defined terms of the product.

Installation Manual: An installation manual is one, which gives quick installation information about either the hardware or software. These sometimes include Quick Start guides. Quick Start guides are the ones inserted in the CD cases or packed with the product composed of 1 or sometimes 10-14 pages.

Online Help: The online helps are the online guides and electronic form of the user guides.

Online Support: Online support is for helping a user through a problem, may it be trouble shooting, looking for a solution or any other difficulty.