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:Liz -dot- Goodwin -at- ametek -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 13 Feb 2002 08:12:56 -0500
Lin Sims wrote:
<So I'm taking a poll. Where do you put your troubleshooting
<information, and why do you put it there?
We have a separate chapter for troubleshooting and diagnostics but this
refers solely to our hardware (analyzers). I feel it is easier to check out
the TOC under troubleshooting and view the topics listed to get to the
section of the manual that you need.
Error messages for software are included in an appendix unless there are
only a few and then they are included in the chapter on the software
operation.
Liz Goodwin
Technical Writer, Dycor
"There are two means of refuge from the miseries of life: music and cats."
(Albert Schweitzer)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
