TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
Determine what it is you absolutely need and just
start writing. If your timeline is 3 weeks, you don't
have the time to plan out everything you need to
write. Just determine what the top documentation
priority is and write it. Then, if you have time,
write the 2nd, and then the 3rd...
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.
Talk to them. Sit down and talk with them about the
product. Ask for copies of any specifications they may
have. Ask to view development logs, if they keep them.
=====
Bill Swallow
Technical Writer
PowerAdz.com
518.687.6107
bswallow -at- poweradz -dot- com
__________________________________________________
Do You Yahoo!?
Yahoo! Photos - Share your holiday photos online! http://photos.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
