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:Re: Troubleshooting COTS Systems From:"Michael Collier" <michael -dot- collier -at- mail -dot- dss -dot- mil> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 13 Aug 2002 14:44:23 -0600
Kind of a broad question, but let's start with the basics. First you must
do a pretty thorough task analysis of the things your users will be doing
with the system. Troubleshooting tips must center around what may impair
accomplishment of these tasks, as opposed to merely regurgitating
troubleshooting info from the vendor docs.
You could look at the system requirements documents and other specs for
some clues. Also, who is responsible for testing the software? You need
access to test plans and procedures; if these don't exist, well, they
really need to be written up (these will tell you how the customer expects
the system to perform; results of failed tests will tell you what you need
to troubleshoot for.)
I've always done maintenance, diagnostic and troubleshooting procedures by
working very closely with the system engineer and the testers, so you'll
probably have to do the same.
DSS Baltimore Operations
Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save! http://www.ehelp.com/techwr-l
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.