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.
Do you include a sentence identifying the dialog name?
Subject:Do you include a sentence identifying the dialog name? From:"Gilda Spitz" <gspitz -at- longview -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 7 Feb 2002 11:13:35 -0500
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.
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."
Just curious to see if the readers on this list have strong feelings on
this topic.
Gilda Spitz
Manager, Documentation Services
Longview Solutions Inc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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? http://www.iuniverse.com/media/techwr
---
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.