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've previously mentioned my loathing of the term "appears" in documentation. I really do not see a great difference between the phrases, "the window is displayed" and "the window appears." The first is passive and the second sounds like the *window* is doing something.
In response to Zen's question, I refer to the pop-up windows as "windows" when they are windows with toolbars and such, but all variations are still windows, O/S-wise. If a new screen opens, like a web app that opens a new page (screen), then I call it a screen. It's a "dialog box" the window really is a dialog box that serves primarily one function that is focused on the dialog in the window that is opened.
My convention when refering to these windows is to say something to the effect of, "Click <widget> to open the <dealybob> window." When "dealybob" is called "Open," then there is a minor issue, but the names of "open" windows for me are usually "File Open" windows or some such.
If something is "recommended," then who is recommending it? If something is the best practice because the practice follows a particular application, administration, or policy standard, then mention that standard as the "who." For the concept, "It is recommended that you change your password every 3 months," then I would say, "It is best to change this password every 3 months." ("This" should be in reference to the password mentioned in the docs. Users have many passwords so "your" is vague.)
Lauren
________________________________
From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com on behalf of Susan W Gallagher
Sent: Tue 10/16/2007 11:22 AM
To: Zen C
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Dialog box/Screen/Window
Zen,
All of the choices you've given are passive voice, so I wouldn't use any of
them. In my world, windows open and dialog boxes appear. And Open is
(usually) a dialog box, so, "The Open dialog box appears."
As for the recommendation, again, "It is recommended..." is passive so I
wouldn't choose that one. I generally say either "<Company> recommends
..." or "We recommend..."
HTH
-Sue Gallagher
On 10/16/07, Zen C <zenizenc -at- gmail -dot- com> wrote:
>
> Hi All,
>
> What is the best term to use?
>
> The Open *dialog box* is displayed?
>
> The Open w*indow* is displayed?
>
> The Open s*creen* is displayed?
>
> Are there any usage rules for these terms?
>
> Also do you say
>
> *It is* recommended to do this or *We* recommend you do this.
>
> Thoughts please.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 <http://www.helpandmanual.com/>
---
You are currently subscribed to TECHWR-L as lt34 -at- csus -dot- edu -dot-
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-
