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.
Re: Procedural syntax: "Click to expand" vs. "Expand by clicking"
Subject:Re: Procedural syntax: "Click to expand" vs. "Expand by clicking" From:Geoff Lane <geoff -at- gjctech -dot- co -dot- uk> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 20 Jan 2006 13:59:04 +0000
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.
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