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.
Subject:documentation process From:UmaP -at- NIIT -dot- com To:techwr-l -at- lists -dot- raycomm -dot- com Date:Thu, 18 Nov 1999 16:44:23 +0530
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.
