Troubleshooting guides

Subject: Troubleshooting guides
From: geoff-h -at- MTL -dot- FERIC -dot- CA
Date: Tue, 15 Jul 1997 10:22:52 -0500

Nancy McDonald asked for advice on writing a
troubleshooting guide. Nancy, the key word here is
"trouble": if you can identify what aspects of the software
will cause trouble for your audience, then you can document
solutions to each such problem. How do you find this out?
Well, start with the problems you and your team personally
encountered while writing the docs. Supplement this with a
list of any known bugs. Add in any information that your
technical support staff or training staff can provide on
common problems that users encounter. This should cover
almost all of what you need to include. Conclude the
chapter with an overview of problem-solving strategies; for
example, if the software's "metaphor" suggests a particular
approach, explain this approach so that users can see how
their problem fits within the approach and attack the
problem with that knowledge.

--Geoff Hart @8^{)} geoff-h -at- mtl -dot- feric -dot- ca
Disclaimer: Speaking for myself, not FERIC.

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: Electronic thesis
Next by Author: Reference on freelance rates and contracts
Previous by Thread: Re: LAW: (long) enforceability of non-compete agreements
Next by Thread: LAW: enforceability of noncompete agreements


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


Sponsored Ads