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.
Subject:RE: Error Message Appendix From:Richard Weir <richard -dot- weir -at- ce -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 16 Jan 2002 10:27:01 +1100
YOu could have a section in youur release notes called "Known Problems" does
not sound as bad as Bugs, I have found users think if viruses when bugs are
mentioned
-----Original Message-----
From: Dave Stewart [mailto:stewed11 -at- hotmail -dot- com]
Sent: Wednesday, 16 January 2002 9:11 AM
To: TECHWR-L
Subject: Error Message Appendix
Hi,
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...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for FREE, through January 15th. 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.
