re: developing a document plan

["shannons" <shannons -at- wwdb -dot- org>]

It also depends on whether they are looking for a user task based documentation or system reference (enter this into this field, this field shows, etc) or a combination.  I use two different approaches for developing a doc plan.

If user based, I have to assume that the user knows little about the system and wants to know how to use it from a real world perspective.  That means identifying user tasks and work flow and coming up with an outline (or TOC) from that end.

If system reference, I simply create the TOC by listing all menus, screens, views, etc in a logical manner and then start filling in the details.  

If they want both and in the same document, that gets tough but some steps just integrating it all and again I have to determine if they (the client) wants the document to be organized from a system perspective or a user task/workflow perspective.

Pretty much count on 3-5 times the hours when you have to do all the leg work and organization yourself.

Hope that helps
...Shannon Stoltz


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

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15.  http://ieeepcs.org/2001/

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