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 07:54:45 -0600

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 five
step process to correct the error. (it was a very technical system) So we
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 Technical
Support team.

Carol Anne

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

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for?

Have you looked at the new content on TECHWR-L lately?
See and check it out.

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: Toastmasters
Next by Author: Re: Error Message Appendix
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