Development documentation?

Subject: Development documentation?
From: Kirsten Zerbinis <k -dot- zerbinis -at- paradynamics -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 4 Dec 2002 17:10:25 -0500


My company wants the developers to start doing some documentation (they currently do none, which is making the transition from a one-developer-per-project setup to a team development environment nightmarish, to say the least), and I said I would do some research on how other companies do this sort of thing. My role is software testing, documentation (user docs, so far), and training.

Can anyone give me some advice, or a good book to read, or a website to go to, so I can get started and learn some basic internal-documentation concepts? I want to present some basic, easily-implementable ideas on how to start documentation procedures, just to capture information like "Yesterday, I fixed the widget that was all flooey in the Data Entry screen".

Thanks,
Kirsten Zerbinis
London, Ontario



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

---
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: Unfamilliar languages
Next by Author: Re: Description of Tech Writers
Previous by Thread: RE: OT: Whaddaya Mean, "The debate that won't die?"
Next by Thread: RE: Development documentation?


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


Sponsored Ads