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.
> I am sure this has been discussed here before but I cannot find it
> in the archives.
It's beaten to death about four times a year. I just searched
the archives for "display appear" and got hundreds of hits.
> For software user guides, I prefer to not use the word, "appear"
> or "appears" when the user clicks a button or selects a menu choice
> and something shows up on the screen. Which sentence below is the
> standard convention for the results of user interface actions?
>
> 1. When you click XYZ on the Main Menu screen, a ABC dialog box is
> displayed.
>
> 2. When you click XYZ on the Main Menu screen, a ABC dialog box
> displays.
>
> 3. When you click XYZ on the Main Menu screen, a ABC dialog box
> appears.
I like #3 (with "a" changed to "an", of course), but there's
a vocal group of writers who'd prefer either "is displayed" or
"opens", because "appears" seems to them to mean "appears as
if by magic". They don't like that for some reason, even
though "appears as if by magic" is PRECISELY what a dialog box
DOES.
A dialog box doesn't have a real-world physical equivalent
like a folder or document -- it's OUTSIDE the desktop
metaphor -- so it doesn't have to "open" like a folder or
document. It's an intrusive, metaphor-breaking interface
between the user and the computer; "appears" describes its
behavior perfectly. Plus, "appears" has an antonym that you
can use when the box goes away; "is displayed" doesn't.
... but that's just my opinion. You really should check the
archives again.
-Andrew
=== Andrew Warren - awarren -at- synaptics -dot- com
=== Synaptics, Inc - Santa Clara, CA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-