Re: troubleshooting guide

Subject: Re: troubleshooting guide
From: Virginia Day <Virginia_Day -at- DATACARD -dot- COM>
Date: Thu, 10 Jul 1997 09:12:02 -0500

Hi,

I've written troubleshooting using two different approaches--it all
depends on the audience.

For a technically knowledgeable user, a "fault isolation" approach
works well. This is a very structured approach that begins with an
indicator--error message, unwanted program result, etc--and has the
user gather additional details to identify the *specific* problem.
You provide a solution to the specific problem. This approach
originated with hardware, and applies to software *sometimes*.

For a naive user, or very flexible applications, I've used tables with
three headings--What you see, Possible causes, and Solutions. I've
had several tables, organized in a way that makes sense to the user
(such as messages, formatting, navigation, etc.). Most "Solutions"
refer back to procedures in the body of the user information. The end
of the troubleshooting section contains a few error-recovery
procedures, all referenced by solutions mentioned in the table.

Hope this helps.

Regards, Virginia
Virginia_day -at- datacard -dot- com

My opinions, not those of my employer.


______________________________ Reply Separator _________________________________
Subject: troubleshooting guide
Author: Nancy McDonald <nmcdonald -at- OTECH -dot- COM> at Internet
Date: 7/10/97 9:46 AM


Hi, all.
I've just "finished" the user guide (for a database system, win95 based,
Oracle, SQL, etc). Now I have to write a troubleshooting guide, hoping
it not take more than a chapter-sized section... (The user manual is
around 300 pp.) Now after I've deleted all the snide remarks, I'd like
to replace them with some real remarks... does anyone have some advice
regarding writing a troubleshooting guide?

Nancy McDonald

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: job angst
Next by Author: Re: Technical writer dream
Previous by Thread: Re: troubleshooting guide
Next by Thread: Re: troubleshooting guide


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


Sponsored Ads