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 number standards From:Dick Gaskill <dickg -at- AG3D -dot- COM> Date:Thu, 19 Mar 1998 12:08:27 -0800
Not sure if there are any "standards" for error messages, but there are
several national standards organizations that might be able to help you.
Personally, I use an alpha-numerical format, as shown below. You can
set up alpha strings to designate the software module and then establish
ranges of error messages to further classify them.
NOTE: if there is any chance that you will be localizing your product
and/or docs, make SURE that the engineers create the error messages in a
message catalog, an external text file called by the software. If they
hard-code the error messages intot he code, you're going to have a lot
of extra expense and QA before the product is released. Been there,
MGR1000 Text of error message (from the software manager);
MGR1000 -1999 = SW MGR GUI error messages, MGR2000 -2999 = SW
MGR miniport error messages, etc.)
ISO (International Standards Organization) is a worldwide federation of
national standards bodies from over 110 countries. To date, ISO has
developed nearly 10,000 standards covering industrial, economic,
scientific and technological activity. http://www.spie.org/