TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
to....
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?
