Re: Pre-requisites for Help Documentation

Subject: Re: Pre-requisites for Help Documentation
From: Chuck Martin <cm -at- writeforyou -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 22 Dec 2004 15:30:03 -0800

Tech Comm.... wrote:

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 â 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.

A good place to start is here:

Chuck Martin
User Assistance & Experience Engineer
twriter "at" sonic "dot" net

"I see in your eyes the same fear that would take the heart of me.
The day may come when the courage of Men fail, when we forsake our
friends and break all bonds of fellowship. But it is not this day!
This day, we fight!"
- Aragorn

"All you have to decide is what to do with the time that is given you."
- Gandalf



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: Re: Outsourcing Tech Pubs
Next by Author: Re: Estimation of the number of pages to be written per day
Previous by Thread: Re: Pre-requisites for Help Documentation
Next by Thread: Documentation Tasks - survey & questions

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

Sponsored Ads