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: Include error messages? From:rbilbao -at- us -dot- amadeus -dot- net To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 1 Aug 2002 13:23:21 -0400
A million thanks to everyone who replied regarding this issue (see below.) The
consensus seems to be that including error message descriptions is a good thing
if done correctly, although some suggested an even better thing would be more
intuitive error messages within the software. Since neither that nor online help
is feasible currently, I'm going to try out an HTML page with good navigation,
as Geoff Hart, Sean Hower, Rebecca Downey, and a few others suggested. It
shouldn't take long to do since I'm fairly good with HTML. Hopefully it won't be
too hard to include in future help or guides.
Oh yeah, and we're planning a class action suit against Microsoft for the
suffering we've endured because we can't include graphics in txt files :o)
Thanks again!
Rhina
rbilbao -at- us -dot- amadeus -dot- net
RE: Speaking of which, what's the consensus on this: a product manager wants me
to
include a list of screenshots of all the possible error messages a user might
encounter using our software with a short (2-3 sentence) description of what it
means because the product has no Help (yes, i know!) included with this first
release. And she wants it done in a text file that will be included on the CD!
I'm fairly new at this but my gut tells me there's got to be a better way. Have
any of you encountered this? How did you handle it?
**********************************************************************
This email message and information contained in or attached to this message
may be privileged, confidential, and protected from disclosure and is intended
only for the person or entity to which it is addressed. If you are not the
intended recipient any retransmission, dissemination, printing or other use of,
or taking of any action in reliance upon, this information is strictly prohibited.
If you received this message in error, please immediately inform the sender by
reply e-mail and delete the message and any attachments. This footnote also
confirms that this email message has been swept by MIMEsweeper for the
presence of computer viruses. Thank you.
**********************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Buy RoboHelp Deluxe starting at only $798: you'll get RoboDemo, the hot new
software demonstration tool that's taking the Help authoring world by storm,
together with RoboHelp Office. Learn more at http://www.ehelp.com/techwr-l
---
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.
