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: Describing buttons and fields From:Janice Gelb <janice -dot- gelb -at- sun -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 04 Feb 2003 16:07:50 -0800
"Dick Margulis " <margulis -at- mail -dot- fiam -dot- net> wrote:
>
> [snip]
>
> So what I'm saying is that I trust the reader to figure
> out that the text transformation I apply to control names
> (using initial caps) does not mean I'm talking about a
> different button.
>
After having emphasized for years that messages and interfaces
had to match the screen text exactly, we finally (with much
wailing and gnashing of teeth) have decided to recommend the
same thing in our style guide. We concluded that readers
were not as likely to be confused about whether the "Open the
Search Tab in the Sidebar When Search Results Are Available"
field was the same as the"Open the Search tab in the Sidebar
when Search results are available" field as they were to be
confused by either (a) the blob of boldface that would be required,
or (b) not using caps at all:
4. Select Open the Search tab in the Sidebar when search
results are available.
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l
---
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.