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.
Subject:re Where do you shoot trouble? From:"Mark L. Levinson" <nosnivel -at- netvision -dot- net -dot- il> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 14 Feb 2002 17:19:46 +0200
I think that sometimes trouble should be shot down
the moment it raises its head, right in mid-procedure.
Though the same solution may also appear in a
troubleshooting chapter or appendix, the user
working through the procedure should be
grateful to find that there is no need to waste
time wondering whether there really is a problem,
whose fault it is, and where to find the solution.
A solution in mid-procedure is particularly
appropriate if--
- the problem is pretty likely to occur
- the problem can occur only at a few easily defined
moments in the procedure
- the problem and solution are simple to explain
- the problem is not very embarrassing to the
manufacturer
For example, "After finishing your drawing, go back
to work on your text. If text that you type fails
to appear, check your pen properties; your pen may
have remained set to the background color."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
---
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.