Re: ? kinds of documentation and steps

["Jane Bergen" <jane -dot- bergen -at- usa -dot- net>]

Hello, Subramanian,

Asking such a broad question is a bit like asking a surgeon, "What
steps do I take to do an operation?" What kind of operation? (software
development is a very broad paintbrush) Who's the patient? (writing
for an audience of engineers is different from writing for an
off-the-shelf product). What are the circumstances? (a thousand
different factors) Why are you operating? (are you the only tech
writer? what kind of access do you have to the product? when do you
need to do it?) What is your operating environment? (what tools do you
have? what tools do you need for this instance?)

There are no links on how to prepare documents. Some of us spend a
couple of years in school working on learning to do that! Others spend
a couple of years in the technical communication profession learning
to do that! Some of us do both!

I suggest that you sit back and just read some of the messages for
awhile. It will give you a better understanding of the profession, of
the list, and of the type of questions that people bring to the list.


----- Original Message -----
From: "subramanian" <subramanian -at- texworld -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Friday, July 28, 2000 1:22 PM
Subject: ? kinds of documentation and steps


> hai all,
>
> i'm a novice to documentation.
>
> what are the documents necessary
> in the software development process.
> can any one get me some useful links or information
> on how to prepare documents -steps and contents.
>
> thanks a lot.
>
> Subramanian