Pre-requisites for Help Documentation

Subject: Pre-requisites for Help Documentation
From: "Caroline Tabach" <Caroline -at- radcom -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 22 Dec 2004 10:39:49 +0200

You need to sit with the programmers and learn how the program works, this is even more than using any type of document. They just provide the background, or details.
In our company we write the user guide and single source it to Help.
Other places do it differently.
If you have a user guide, then the easiest thing is indeed to convert it to Help.
Once you know how the program works, then you have to tell a person how to use it, as people said, screen by screen.
You have not provided much information, what type of help is required, WinHelp, Html help?
do you know what application you will be using?

From: "Tech Comm...." <>
Date: Mon, 20 Dec 2004 12:19:40 +0530
X-Message-Number: 3
Can any body tell the pre-requisites for a Technical Writer to prepare
a help document?
I mean what are the docs or process involved????
I am jotting down what I am provided with in my company.
1. Knowledge Transfer =E2=80=93 On application developed.
2. Functionality Document [it talks about tables only and occasionally
validations] nothing about the fields.

TW's please let me know what is the industry process.
Caroline Tabach
e-mail: CarolineT -at- radcom -dot- com



RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo:

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Seeking counsel - yet another difficult work situation
Next by Author: Re: Hyphenation in technical documentation
Previous by Thread: Re: Pre-requisites for Help Documentation
Next by Thread: Re: Pre-requisites for Help Documentation

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

Sponsored Ads