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.
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?
Thanks,
Dave...
_________________________________________________________________
Join the world?s largest e-mail service with MSN Hotmail.
http://www.hotmail.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? http://www.iuniverse.com/media/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.