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:Where do you shoot trouble? From:"Lin Sims" <linda -dot- sims -at- verizon -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 12 Feb 2002 16:38:17 -0500
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.
All One Chapter
1. No need to decide which individual topic is the best one to put a
solution with (if it's applicable to more than one problem)
2. No arguments from the SMEs about where the information belongs
(yes, I've had this happen)
3. SysAdmin only has to look in one place instead of guessing which
chapter it might be in (principle of "all the same type of information in
1. SysAdmin may expect to find troubleshooting info in chapter
dealing with system component/function they're having trouble with
(principle of "all the information on a topic in one place").
My general rule is "find out what they want and give it to them", but I've
talked to sysadmins on both sides of this debate. A good index would
probably solve the problem completely, but since I have to learn how
to index first (both the art and the process in FM), and then find the
time to actually create an index, this isn't going to happen anytime
So I'm taking a poll. Where do you put your troubleshooting
information, and why do you put it there?
Of course I'm willing to take 'No' for an answer, so long as 'No' was the
answer I was looking for.
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.