Re: How do you document error messages?

Subject: Re: How do you document error messages?
From: James Barrow <vrfour -at- earthlink -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 18 Sep 2004 11:07:13 -0700


I set up a Lotus Notes database for all of our support and Help Desk information. The database was broken down into categories for each application. For instance:

Microsoft Word:
>System Doc (describing the what the app does, who uses it, etc.)
>How Do I? (common questions a user might ask regarding the basic functionality)
>Sypmtom (descriptions and resolutions for common error messages)

In theory, this worked great. The only problems that I encountered was in trying to get users to go to that database instead of calling the engineers, etc.

Since we were using ZENworks to push app objects out to clients, we took advantage of Novell's alert capabilities. If we anticipated problems with the installation or upgrade of an application, the administrators could send out alerts that would appear on a user's desktop. These were brief descriptions of the problems that they might encounter and, more importantly, whom to call or where to go in the database to get more information.

If you have products that do not generate error messages, then identifying common problems takes more effort. If these are custom apps, then you would probably have to set up a small test group to pound away at the app until a problem occurred. Then you'd have to work with the developers to document a workaround or fix.

If these are out-of-the-box apps, you could probably look on the manufacturer's website for TIDs, or check their FAQ section. At the very least, simply go to Google and enter: [name of app] troubleshooting.

- Jim

On Sep 17, 2004, at 2:35 PM, mearro -at- msn -dot- com wrote:


Our organization desperately needs to provide our users & support staff
with more info about the error messages that our various products produce.
I'd appreciate anything you could share about how your organization
handles this as well as what kind of information you document.

Currently, our error messages display with vague descriptions written by
our developers. We're hoping to add more meaningful content to each error
message as well as to the Help systems & other docs. We'd like to identify
info that our support staff (& likely users) really want to know: what
caused the error message, how to avoid it, and possible workarounds.

One difficulty we have is how to identify the error messages (not all of
our products generate a list of messages).

So far, this has been a documentation-only task for us. We have extremely
limited resources & simply don't have access to the information we need.
I've gone through our problem logs and support notes to try to get
additional info but I've spent too much time for too little results.

Any experiences you could pass on - I'd appreciate.

Mary - I'm on digest - please email me.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re: Another question I've had for years...
Next by Author: Re: contract length
Previous by Thread: How do you document error messages?
Next by Thread: Re: UK friendly? --- plus bonus joke!


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


Sponsored Ads