Do you include a sentence identifying the dialog name?

Subject: Do you include a sentence identifying the dialog name?
From: Steven Oppenheimer <writer -at- writemaster -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 08 Feb 2002 11:00:35 -0500


Actually, the most important thing that you are doing is saying how to access the dialog box in the first place (Choose Database->Password). I can't begin to tell you how much (semi-useless) documentation I've seen (especially online help) where you are told how to use the dialog, but not how to find the damn thing to begin with! Drives me crazy!

Steve Oppenheimer
writer -at- writemaster -dot- com

From: "Gilda Spitz" <gspitz -at- longview -dot- com>
Date: Thu, 7 Feb 2002 11:13:35 -0500
X-Message-Number: 21

We've been having an interesting discussion here.

Let's say we have a dialog named "Change Password". In our procedures,
we insert a numbered step consisting of two sentences: "Choose Database
-> Password. The Change Password dialog appears.", followed by a picture
of the dialog. In the second sentence, there's an index marker for the
dialog name.=20

The discussion is this: We're thinking of ways to improve our text, both
to ensure the English is as good as possible, and to minimize
translation costs. So there are several choices:

* keep the status quo
* delete the second sentence (if we did this, we'd have to move
the index marker elsewhere)
* change the second sentence to "The following dialog appears." =20

Just curious to see if the readers on this list have strong feelings on
this topic.=20

Gilda Spitz
Manager, Documentation Services
Longview Solutions Inc.=20

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of your book. What are you waiting for?

Have you looked at the new content on TECHWR-L lately?
See and check it out.

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: Menu: what to call it
Next by Author: RE: Pricing Documentation and Estimating Timeline
Previous by Thread: Re: Do you include a sentence identifying the dialog name?
Next by Thread: RE: Do you include a sentence identifying the dialog name?

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

Sponsored Ads