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.
Subject:Re: Click to add From:Chris Hamilton <chamilton -at- GR -dot- COM> Date:Wed, 26 Mar 1997 15:30:50 -0600
geoff-h -at- MTL -dot- FERIC -dot- CA wrote:
> Just to throw another log on the fire... I'd actually
> prefer to see most of the imperative instructions we've
> seen during this thread reversed: Rather than "Click Y to
> do X", go with "To do X, click Y". (Rationale: Provide
> context before details. Relevant jargon: "metadiscourse",
> "using advance organisers", etc.)
All relevant jargon aside, the reader is only going to use this for that
kind of context once (at most a handful of times). After that, the
reader will be more interested in what the step is. Putting it at the
beginning of the step, rather than framing it in context first, costs a
little time on the first reading, but saves time on subsequent readings,
especially if the reader's not an absolute beginner. For the most part,
I know what I want to do, I go to the doc to determine how to do it.
Chris Hamilton, Technical Writer
Greenbrier & Russel
"The essence of greatness is the preception that virtue is enough." --
Ralph Waldo Emerson