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.
Hi,
Now that you know the language guidelines that will be required to set-up, lets
get to the rest of the issues.
::Kinds of documents :
You can decide on the kinds of the documents/number of documents based on the
following criteria.
a. The intended audience: depending on each user category you can have a
manual.
->System Administration Guide: Dedicated to Sys
Admins.
->Getting Started Guide: For anybody who will
use the system
->User Guide: For Sys Admins, Developers and
other users
->Quick Chart/Installation guide: For all.
This makes the number to 4 manuals. This can change depending upon the actual
product. For example. If its a toolkit/SDK you are documenting then you could
have an API Ref. Guide and So on and So forth.
::Medium of output :
This is dependent again on the product. If its a stand alone application, then
you could have an online- help [which can HTML based or the normal winhelp
style]. You can also provide stand alone HTML based help. If the application
resides on a central server and its accessed over the network, then you can also
provide a HTML Manual or PDF file. Hardcopy/Printable version of the manual is
always a plus.
::Tools to be used:
Will depend on the medium of output, refer above.
I guess this should get you thinking about the documentation process. Let me
know if you have received any other answers to this.
Cheers!
Brijesh
-----Original Message-----
From: UmaP -at- NIIT -dot- com [mailto:UmaP -at- NIIT -dot- com]
Sent: Thursday, November 18, 1999 4:44 PM
To: TECHWR-L
Subject: documentation process
Importance: High
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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: brijesh_b1 -at- verifone -dot- com
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.
