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:bryan -dot- westbrook -at- amd -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 13 Feb 2002 10:18:21 -0600
Its own chapter or an appendix, with references to any appropriate sections that are needed for fixing the problem. Most people are only going to refer to the manual for only two reasons, and if the setup is self-explanatory only one: when something goes wrong. Don't make someone who is probably already frustrated have to go hunting for the troubleshooting mixed into the other text. If they knew where to look for the fix already they wouldn't be using the T/S section anyway. They would just go to the procedure.
From: Lin Sims [mailto:linda -dot- sims -at- verizon -dot- net]
Sent: Tuesday, February 12, 2002 3:38 PM
Subject: Where do you shoot trouble?
For my own peace of mind, I want to make a decision I can stick to.
Where should troubleshooting information go, in a chapter all of its
own, or scattered through the chapters covering the individual areas
where trouble may arise? There are reasons for going either way, and
I've been dithering between them for too long.
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/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.