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.
The questions you've asked are the basic questions of technical
writing. Surely these were discussed in your job interview. How did
you get this assignment? If you were assigned to do this by a company
where you already worked, then I would talk with the professional
writers there. If your company has none, you might get some technical
communication books. You don't say where (country) you are located,
but if possible check with your local STC chapter. They might have
some workshops or seminars to help you.
No one on this list can tell you "the kinds of documents to be
produced" -- that comes from your company and the needs of your
audience. The "medium of the output" and the tools are usually decided
by or at least influenced by your company and ......"the kinds of
documents to be produced."
----- Original Message -----
From: <UmaP -at- NIIT -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Thursday, November 18, 1999 5:14 AM
Subject: documentation process
> Hi all,
>
> I will shortly be required to set up documentation process in an
> organization that 'works' on telecommunication products and
projects.
> Apart from the idea that I'll be required to write manuals, I'm not
very
> clear on where to begin. While I'm very confident of the language
guidelines
> that I will be required to set up, I'm not very sure about the
technical
> part. For instance, what are the kinds of documents to be produced,
what
> should the medium of the output, what are the tools to use, are
there any
> good Web sites for such information? What would be the essential
parts of a
> manual, its TOC etc.
> I will really appreciate any help on all this or parts.
>
> Regards,
> Uma
>
>
>
> Visit http://www.niit.com for eCommerce Solutions.
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Sponsored by Weisner Associates Inc., Online Information Services
> Training & consulting for RoboHELP, Dreamweaver, HTML, and
HTML-Based Help.
> More info at http://www.weisner.com/train/ or mailto:training -at- weisner -dot- com -dot-
>
> Sponsored by Rose Hill, Your Business and Career Coach.
> "Assume Success! Live Your Passion!" Get the gist at
> www.coachrose.com then call 503.629.4804 for details!
>
> ---
> You are currently subscribed to techwr-l as: jbergen1 -at- EARTHLINK -dot- NET
> To unsubscribe send a blank email to
$subst('Email.Unsub')
> Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
>http://www.raycomm.com/techwhirl/ for more resources and info.
>
>
