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.
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
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 T. Wall, FLMI
Technical Writer - Individual Business Technology, Minnesota Life Insurance
Company
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. www.ehelp.com/techwr
---
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.