technical documentation for software

[SANDY BAKER <SANDYBAKER -at- afninet -dot- com>]

Does someone have advice about gathering and writing technical documentation
for software? 

I've been asked to devise a plan for documenting the software for a
'fast-paced environment'. Documentation is the LAST thing the developers
want to hear about when they've got three weeks to develop and test an
application.

We're trying to establish what the minimum requirements for documentation
are: 
*	Service Request (actually the User's document)
*	Application Requirements
*	System FlowChart
*	Data Dictionary: Description of Files and Databases (DBAs are
actually doing this part)
*	Technical Information needed for Testing, Installation, Maintenance
*	Application (Version) Release  

I'd also like some hints for getting this info from developers to tech
writers, since tech writers are responsible for getting this all down on
paper.




 




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

          Sponsored by an
 anonymous satisfied subscriber since 1994.

---
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.