Re: my bad displays habit

Subject: Re: my bad displays habit
From: Mike Starr <mike -at- writestarr -dot- com>
To: suzchiles -at- gmail -dot- com
Date: Tue, 02 Mar 2010 11:06:39 -0600

Click the *Settings* button. <program name> displays an *Edit Settings* dialog box similar to the one shown here.
[screen capture]

In spite of the collective received wisdom that my approach is wrong on so many levels, I'll continue to use it unless a corporate style guide expressly dictates otherwise. I like to make sure the user knows exactly what the result of his/her action will be. Yes, this may be tedious for both the writer and the reader but I prefer to think the clarity of this approach adds enough value to outweigh the tedium.

Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com -

Suzanne Chiles wrote:
> I have fallen into the bad habit, when writing task topics, of following the
> instructions with sentences like "The Edit Settings window displays." I know
> this is bad usage, but all other versions of this type of information seem
> awkward and overly-thought-out. I think it goes back to a manager I had many
> years ago who wouldn't let us say "appears" because she thought it made it
> sound like the results of a magic spell.
> Anyway, I am open to suggestions.
> tia,
> Suzanne

Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

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.

Please move off-topic discussions to the Chat list, at:


Previous by Author: Re: CMS? Web site? WordPress?
Next by Author: Re: Famous Last Words
Previous by Thread: RE: my bad displays habit
Next by Thread: Re: my bad displays habit

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

Sponsored Ads