Re: Error Message Appendix

Subject: Re: Error Message Appendix
From: CarolAnne -dot- Wall -at- minnesotamutual -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 16 Jan 2002 08:21:20 -0600

I forgot to add -- the error messages were in their own section of the
documentation, alphabetized by the error message text. It was the easiest
way for our users to look up the solutions.

Carol Anne

> I once worked on a system where it didn't matter how eloquently the
> programmer might phrase the error message. It was still going to be a
> step process to correct the error. (it was a very technical system) So
> took this approach in the documentation.
> Error Message Statement
> Problem: <insert detailed description of the problem -- might as well
> educate your users>
> Solution: <insert detailed steps to solve the problem>
> It worked for the users, and it made life a little easier for the
> Support team.

Carol Anne T. Wall, FLMI
Technical Writer - Individual Business Technology, Minnesota Life Insurance
carolanne -dot- wall -at- minnesotamutual -dot- com

Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you.

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 for more resources and info.

Previous by Author: Re: Error Message Appendix
Next by Author: RE: Most dreaded part of the job?
Previous by Thread: Re: Error Message Appendix
Next by Thread: Re: Error Message Appendix

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

Sponsored Ads

Sponsored Ads