Re: Select, choose, click style guide

Subject: Re: Select, choose, click style guide
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 24 Sep 2008 18:16:11 +1000

Ned Bedinger wrote:
> Janice Gelb wrote:
>> Ned Bedinger wrote:
>
>>> 1. Edit > Find > Replace > All
>> Readers can indeed probably figure out what you
>> mean but your solution seems to me to be the
>> equivalent of writing a sentence of all nouns
>> without any verbs. I think that adding a simple
>> imperative verb makes the instruction clearer
>> and the step would be more quickly read and
>> comprehended.
>
> Yes, that isn't unreasonable--it communicates in a standard way--but is
> one of the most common types of instruction. I'm not so sure that
> anything is gained by sticking to standards at the level of the
> ordinary, mundane instruction.
>
> I forget where I first saw it done as Edit > Find > ..., but I'm drawn
> to it as the atheistic alternative to the religious beliefs about the
> right standard way. I do want written knowledge transfer to be
> progressive. It needn't be stuck in 1980 vocabulary reflecting concerns
> about how to get people to use a mouse! We've learned that mousing isn't
> a big problem area requiring finely segmented vocabulary. Haven't we?
>

I don't think mousing "is a big problem area requiring
finely segmented vocabulary." I do think that including
an imperative verb in a step makes reading the instruction
easier for the user. People are used to reading with verbs
and nouns. The fact that a piece of text that they're
expected to read has a number in front of it does not
change that expectation, imho, and eliminating expected
verbs could cause confusion or at least hesitation.

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address


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

ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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.


References:
Select, choose, click style guide: From: Rob Hudson
RE: Select, choose, click style guide: From: Jennifer Randel
RE: Select, choose, click style guide: From: Chinell, David F (GE EntSol, Security)
Re: Select, choose, click style guide: From: Ned Bedinger
Re: Select, choose, click style guide: From: Janice Gelb
Re: Select, choose, click style guide: From: Ned Bedinger

Previous by Author: Re: Select, choose, click style guide
Next by Author: Re: Need examples of system documentation
Previous by Thread: Re: Select, choose, click style guide
Next by Thread: RE: Select, choose, click style guide


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


Sponsored Ads