How the documentation process is supposed to work in IT

Subject: How the documentation process is supposed to work in IT
From: Marie Parker <marie -dot- parker -at- avv -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 7 Mar 2003 19:44:16 -0500


Hello,

I'm relatively new to technical writing and end user documentation so, by in
large I'm making it up as I go. I work for a small (just under 100
employees) Internet company that provides online services to car
dealerships. Before I was hired there was no documentation department. We
now have an online and print manual, Quick Start Guides, and are developing
online tutorials. However, there is just no existing documentation and no
processes in place for writing system requirements, programming, and
creating end user documentation. Can any of you suggest good references or
sites that detail how the process works, "in a perfect world".


Thank you,
Marie Parker

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Order RoboHelp Office X3 by March 14 and receive a $100 mail-in rebate,
plus FREE WebHelp Merge Module and FREE iMarkup Software, for a
total giveaway value of $439! Order today at http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: Need feedback
Next by Author: Exporting FreeHand to .pdf
Previous by Thread: Application unable to open FV 5.0 files on Unix
Next by Thread: Re: How the documentation process is supposed to work in IT


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


Sponsored Ads