Re: Pre-requisites for Help Documentation

Subject: Re: Pre-requisites for Help Documentation
From: TechComm Dood <techcommdood -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 20 Dec 2004 21:54:58 -0500

> Can any body tell the pre-requisites for a Technical Writer to prepare
> a help document?

Brains... talent... ambition... work ethic... and in some cases,
chocolate... ;-)

> I mean what are the docs or process involved????

I don't understand the question.

> I am jotting down what I am provided with in my company.
> 1. Knowledge Transfer â On application developed.
> 2. Functionality Document [it talks about tables only and occasionally
> validations] nothing about the fields.

You take the info you have at your disposal, use the product you need
to create Help for, and start writing topic by topic, noting both the
UI entities and the tasks using them.

> TW's please let me know what is the industry process.

There are many. They usually sit in one (or more) of three buckets:
stand-alone projects, repurposed projects, or single-sourced projects.



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.

Pre-requisites for Help Documentation: From: Tech Comm....

Previous by Author: Re: Dilbert - English Degree
Next by Author: Re: Ctrl+C or CTRL+C
Previous by Thread: 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