Re: Developing a troubleshooting guide

Subject: Re: Developing a troubleshooting guide
From: "Glen Blair" <glen -dot- blair -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 8 Mar 2006 10:21:38 -0800

Thanks to all of you for your advice!

I've spoken with some of our field service engineers and have been
able to identify a handful of troubleshooting techniques/pathways to
incorporate into the first draft of this document (I imagine it will
grow and morph through at least a few forms before we get something
that's useful both in the field and in the call center).

I especially liked Al's idea of developing an FAQ to go along with
this. There's a guide that accompanies the machine, explaining what
steps the operator should take to optimize the machine's performance.
Part of my plan for improving the whole documentation package includes
significant additions to the performance optimization guide that will
better explain operation techniques and the machine's performance if there was just a way to get the customers to
read that _before_ they called for help! :-) A running FAQ (even if
it's just in-house) sounds like a good way to track new and existing
performance issues that can later be addressed in troubleshooting and
the performance optimization guide.

Thanks again! This list has been a great resource for someone (me) new
to the tech writing field!


"The atmosphere of the average workplace
is to productivity what flames painted on
the side of a car are to speed."
-Paul Graham

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!.

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

RE: Developing a troubleshooting guide: From: Morton, Christopher

Previous by Author: Developing a troubleshooting guide
Next by Author: Font Type/Size for online help?
Previous by Thread: RE: Developing a troubleshooting guide
Next by Thread: RE: Developing a troubleshooting guide

What this post helpful? Share it with friends and colleagues:

Sponsored Ads