Re: Recommending Guideline

Subject: Re: Recommending Guideline
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 19 Jun 2007 10:43:52 +1000

Ben wrote:
> In a previous job, we avoided "recommending" anything in our manuals.
> Alternatively, we reworded our recommendations in the form of "tested"
> methods and such. I was curious if anyone else is familiar with that
> guideline. Come to think of it, I never really asked why we did that. I
> guess I assumed it was to avoid legal ramifications.

We avoid the word "recommend" also, but not
necessarily for legal reasons. We have a couple
of reasons to avoid the term: first, because it
usually was phrased in either first-person plural
or passive voice, both of which we discourage.
("We recommend that you..." "It is recommended to...")

Mainly, though, we avoid "recommend" because most of
the time it is unnecessary verbiage. Instead of saying
"We recommend that you set the storage limit to
1 Gbyte," why not just say "Set the storage limit
to 1 Gbyte"? Even better, provide the reason rather
than just the recommendation. "To improve performance,
set the storage limit to 1 Gbyte."

-- Janice

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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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

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 for more resources and info.

Recommending Guideline: From: Ben

Previous by Author: Re: Deciding on a Dictionary of Modern English Usage
Next by Author: Re: Online vs paper-based editing
Previous by Thread: Recommending Guideline
Next by Thread: And Or

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

Sponsored Ads