RE: Is there a more succinct way to say this?

Subject: RE: Is there a more succinct way to say this?
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
To: "Janice Gelb" <Janice -dot- Gelb -at- Sun -dot- COM>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 23 Mar 2009 09:20:20 -0700

Along the lines Janice suggests, you may want to step back and ask a
more basic question. Do you want to define every possible path to your
users or take a minimalist approach, describing one path and leaving it
to them to figure out other paths (granted other paths conform to
popular standards)? In other words, since "Enter" works instead of "OK"
in most Windows applications, why not simply say "Click OK" and leave it
to the user to figure out that he can also press "Enter" (granted he is
using a Windows application)?

Leonard

-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Janice Gelb
Sent: Saturday, March 21, 2009 2:58 PM
To: TECHWR-L
Subject: Re: Is there a more succinct way to say this?

Cardimon, Craig wrote:
> Is there a better way of saying, "Press ENTER or click the OK button?"

>
> After you type something like this in 700 million times, you begin to
> wonder.
>

You can establish this in a general section about
how the interface works ("If the OK button is
highlighted, pressing Return is the equivalent
of clicking the OK button") and then in the actual
steps, just say "Click OK."

Our style guide recommends including "the xxx button"
if the button is not a common one but we feel that
users will not be confused by common buttons like
OK or Cancel and that you can just say "Click OK"
in this case.

-- Janice

***********************************************************

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Is there a more succinct way to say this?: From: Cardimon, Craig
Re: Is there a more succinct way to say this?: From: Janice Gelb

Previous by Author: What's wrong with Times New Roman?; was, RE: Hey! She messed with *my* manual
Next by Author: RE: What's wrong with Times New Roman?; was, RE: Hey! She messed with *my* manual
Previous by Thread: Re: Is there a more succinct way to say this?
Next by Thread: Re: Is there a more succinct way to say this?


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


Sponsored Ads