Documenting error messages

Subject: Documenting error messages
From: technical -at- theverbalist -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Mar 2005 13:12:16 -0700


So, not in any way related to the news of the death of RoboHelp,
exaggerated or otherwise, I was messing about with RoboHelp at home for
the first time in ages, and got an error message "RoboHelp can't find
Word"--a pretty specific, if somewhat anthropomorphic error message. So of
course I tried looking in RoboHelp's Help for "can't find Word". But I
couldn't find nuthin. Eventually, after much thrashing about I found a
topic that said if I'd upgraded Word--which I had--that I would have to
reinstall RoboHelp. But there didn't appear to be any information in the
Help that specifically related the error message to any information that
would help me fix the error.

So, my question is--are any of you doing anything innovative in
documenting error messages, and how do you do it? How do you make a
connection in your docs between the error and the solution? How do your
users find the information to fix the error?

Documentally,
Mandy

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

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
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 lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Ensuring the effect is not affected
Next by Author: TECHWR-L Premium Jobs, Events, and Announcements
Previous by Thread: Re: Ghostwriters
Next by Thread: Re: Documenting error messages


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


Sponsored Ads