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.
> my documentation is becoming half "What to
> do", half "What not to do".
I'd take a task-oriented approach and just document "what to
do." IMHO all the "what not to do" stuff should be filed in the
bug-tracking system.
If you have a reference topic for each script, maybe you could
include a list of all the correct ways to launch the script. Or
maybe just a big matrix showing which screens to use for which
script.
> error messages and dialogs that pretty much,
> say (paraphrasing), YOU CAN'T DO THAT from here"
Good! Sounds like the errors are already well-trapped. I
wouldn't spend time explaining how to avoid getting the error
message.
Good luck,
Mike O.
__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage http://sports.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.
www.ehelp.com/techwr
---
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.
