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.
Yes -- I have written troubleshooting guides that include error message
tables, with the errors in alphabetical order. The columns in the table
were:
Error Message
Possible Cause
Suggested Solution(s)
Of course, I agree that more accurate and descriptive error messages are BY
FAR the best solution, but at the time, we had to work with what was there.
Sometimes I've had to explain a few major errors in the Readme file, as
well.
Beth Kane
Sr. Tech Writer
NCS Learn, Services/Systems Engineering
Tucson, Arizona
beth -dot- kane -at- ncslearn -dot- com
-----Original Message-----
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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
