Generic Structure of an Application Help File

Subject: Generic Structure of an Application Help File
From: ptaneja -at- velos -dot- ssind -dot- com (Prerna Taneja)
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Jun 2000 12:35:41 +0530

Hi All,
I need some inputs from you all regarding the structure etc. of an
application Help file.
I am creating a Help file for a Healthcare application being developed by my
organization. At present, the focus of the Help file is task-based, i.e. How
I would like to know what type of information is generally being put in the
Help files. Is the focus on "What is..." or "How to...".
Also, should technical information (Example: information about the sources
from where the application fields are populated) be placed in the Help files
or is it better to put such information in separate technical documents?


Prerna Taneja
Technical Writer
New Delhi

Previous by Author: Software for creating graphics
Next by Author: problem in running a WinHelp file on a Windows 98 system
Previous by Thread: Re: Annoying grammar question...
Next by Thread: RE: imperative/continuance/directive (was: Tech Writer screening questions)

What this post helpful? Share it with friends and colleagues:

Sponsored Ads