Re: Procedural syntax: "Click to expand" vs. "Expand by clicking"

[Geoff Lane <geoff -at- gjctech -dot- co -dot- uk>]

On Friday, January 20, 2006, Yves Barbion wrote;

> just wondering, which do you prefer (and why):

> [A] Click the plus sign to expand the folder.

> OR

> [B] Expand the folder by clicking the plus sign.

> Any references to style guides, maybe? I checked the Microsoft Style 
> Guide for Technical Pubs (Procedural syntax) but did not really find an 
> answer there.
---

It depends. If expanding the folder is a mandatory step to the
procedure, then [A].

Reason: the primary text (that which the user must know) appears
        before the text that explains why the user must perform the
        operation. The procedure would work if the user didn't read
        beyond "Click the plus sign".

However, if the operation is not mandatory, I'd write "To expand the
folder, click the plus sign."

Reasons: "by clicking the plus sign" is passive and gerunds can cause
         issues with localisation.

HTH,

-- 
Geoff

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy.  Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

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

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