Re: Use of Optional in instructions

Subject: Re: Use of Optional in instructions
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 11 Sep 2009 12:30:41 -0700

The title of and introductory text (if any) for a procedure tells you
what it will accomplish.

Each step in the procedure is then typically a simple "do
this"--unless the step is optional.

If you follow the "do this" with "optionally," some users will do
first and then have to undo after they realize they didn't want that
option.

On Fri, Sep 11, 2009 at 12:23 PM, Boudreaux, Madelyn (GE Healthcare,
consultant) <MadelynBoudreaux -at- ge -dot- com> wrote:
> Richard Combs wrote:
>
>>RIGHT: "To accomplish X, do A."
>>WRONG: "Do A to accomplish X."
>
> Interesting. I've always preferred the other route, on the grounds that
> Richard's method buries the lede. The procedure is what you do, and any
> explanation, editorializing, or notation is secondary. A user who is
> just following orders reads the DO THIS step, and skims the explanation
> that follows; a more curious user reads it all. Users are like ornery
> horses: you can lead them to understanding, but you can't make them
> partake.
>
> I prefer:
> * Turn off the water at the source to prevent further flooding.
> * Remove hand from hot stove to minimize burns.
> * Press OK to continue.
>
> All of these are more immediate than:
> * To prevent further flooding, turn off the water at the source.
> * To minimize burning, remove hand from hot stove.
> * To continue, press OK.
>
> Plus, there's that extra character in the second versions. Any time I
> can eliminate punctuation without in any way affecting the
> understandability of the writing, I take it. Just one teeny step toward
> simplification, fewer moving parts, and easier translation.
>
> Can you give me insight on why you do it your way, or, if you prefer,
> why my reasoning is wrong?
>
> Oh, and to return to the original question, how about:
> I like using a repeated, semi-visual cue, like adding [Optional] at the
> beginning of those steps, because it adds to scanability -- the user can
> quickly pick out the required and optional steps, without wasting much
> thought.
>
> - Madelyn
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

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:
Use of Optional in instructions: From: Bruce Megan (ST-CO/ENG2.2)
RE: Use of Optional in instructions: From: Combs, Richard
RE: Use of Optional in instructions: From: Boudreaux, Madelyn (GE Healthcare, consultant)

Previous by Author: Re: Question - Training Guides - Who Writes?
Next by Author: Re: How to subscribe to list?
Previous by Thread: RE: Use of Optional in instructions
Next by Thread: RE: Use of Optional in instructions


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

Sponsored Ads


Sponsored Ads