Error Message Appendix

Subject: Error Message Appendix
From: "Dave Stewart" <stewed11 -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 15 Jan 2002 15:10:55 -0800


For the software I currently document, the engineers have written a large number of error messages that appear when a user performs a task incorrectly.

For instance, an error message will pop up on the screen when a user neglects to import a required file or types a number that is outside the minimum and maxiumum allowed values for a certain parameter.

We've received feedback from customers that the error messages are not descriptive enough, and we're working on making the messages more comprehensible so users know exactly what went wrong and how to fix the problem.

I'm wondering if anyone has ever included an appendix in their documentation listing each error message in the source code, along with more extensive descriptions of the solutions to each problem?



Join the world?s largest e-mail service with MSN Hotmail.

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: Seeking VxWorks BSP Documentation advice
Next by Author: Popular scientific writing
Previous by Thread: Re: Brief introduction and request for advice
Next by Thread: Re: Error Message Appendix

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

Sponsored Ads

Sponsored Ads