RE: documentation process

Subject: RE: documentation process
From: "Brierley, Sean" <Sean -at- Quodata -dot- Com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 19 Nov 1999 09:28:51 -0500


Please believe I am not being snooty, and if you think I am please hit the
delete key, but I recommend you get a professional writer to do the job:
either on-staff or as a contractor.

I could recommend you pickup some good books, such as The Chicago Manual of
Style, the Microsoft Manual of Style for Technical Publications, etc.,
depending on what you write about and in which country and language you are
writing. However, your questions seem more fundamental than that.

All the best and good luck,

sean -at- quodata -dot- com

> -----Original Message-----
> From: UmaP -at- NIIT -dot- com [SMTP:UmaP -at- NIIT -dot- com]
> Sent: Thursday, November 18, 1999 6:14 AM
> 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

Previous by Author: RE: Tech Writing: The Next Generation
Next by Author: RE: would you?
Previous by Thread: RE: documentation process
Next by Thread: Re: documentation process

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads