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-post: Error Messages: Text for the title bar From:David Rapport <dave -at- netmedia -dot- net -dot- il> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 19 Jan 2003 17:13:28 +0200
(Note: This was posted at the end of December and didn't generate
much of a response (though thanks to those who did!), possibly due
to the holiday period. In the hope of generating a broader
discussion the message is re-posted, with kind permission of Eric.)
I have been doing a little Web research into the art of writing error
messages. The consensus seems to be that they should include a
statement of the problem, the cause and how the the user can solve
the problem.
All in the most concise and informative way possible.
I would like to address a related question -- what should be included
in the title bar of the message? I haven't seen anything that directly
addresses this question.
Based on what I have seen I would like to suggest the following
guidelines for title bars in error messages. The guidelines are in
descending order. That is, if "1" is not relevant or possible, try
guideline 2, and so on.
1. A brief description of the remedy.
2. A brief description of the error/problem.
3. A description of the context within the application (eg Printing,
Saving).
4. The name of the dialog box that appeared prior to the error.
(Sometimes this will be the same as 3.)
5. The application name. This would be a default for all messages, if
nothing else is appropriate.
What sayeth the list?
TIA for all comments,
David Rapport
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
---
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.
