documenting parametised messages

Subject: documenting parametised messages
From: "David O'Brien" <OBrien_David_P -at- cat -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 26 May 2003 11:07:45 +1000

We are creating a document that includes error messages, the
situation that led to the message and available solutions.
In many cases the error message is generated from a single
parametised phrase, such as "Expected (0) values but only
(1) were provided". This could manifest itself to the user
as "Expected 3 values but only 2 were provided" or
something similar.

Does anyone have experience or suggestions as to how this
should be documented? e.g., insert typical values with
notes explaining possible variations, keep the the
parameter entry points (probably not a good idea) or
something else?

thanks a lot.

David O'Brien
Caterpillar MineStar Solutions

Phone: 617 3329 8122
Fax: 617 3329 8101

Email: david -dot- obrien -at- cat -dot- com

The package said "Install Windows NT or better" so I
installed Linux.


Robohelp X3, from eHelp, lets you quickly and easily create
professional Help systems for all your Windows and Web-based
applications, including Net.

Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

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 for more resources and info.


Previous by Author: FW: Automating docs compilation in the software build process
Next by Author: Dynamic Help
Previous by Thread: getting the job done
Next by Thread: Re: documenting parametised messages

What this post helpful? Share it with friends and colleagues:

Sponsored Ads