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:Standards And Content For A Technical Manual From:Rohina P Daruwala <ind295 -at- ZIN01MSPGEXCH -dot- CORP -dot- MOT -dot- COM> Date:Thu, 10 Sep 1998 11:51:43 +0530
I need some help. I have been asked to prepare a process document with
standards for writing a Technical Manual. My audience will be the
programmers who wrote the software and other technical people. The
manual will have to be pretty technical and very indepth defining
backend stuff and all that.
I have never really carried out a task like this, I would appreciate it
if I can get some help on:
* What should go into the Process Document - How I should go about
writing the Technical Manual - guidelines etc.
* What should go into the Technical Manual - How it should be structured
out - What are the topics I should cover?
* Most Important are there any set/defined Standards for writing a
Technical Manual that I can follow??
Please reply directly to me. My email id is ind295 -at- email -dot- mot -dot- com