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.
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.
---
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.
