technical documentation for software

Subject: technical documentation for software
From: SANDY BAKER <SANDYBAKER -at- afninet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Dec 2000 10:02:15 -0600

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

We're trying to establish what the minimum requirements for documentation
* 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

Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. 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 for more resources and info.

Previous by Author: RE: Post-holiday reality: They don't need our stinkin' manuals??
Previous by Thread: Teacher turned Tech Writer -
Next by Thread: Re: technical documentation for software

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

Sponsored Ads