Re: my bad displays habit

Subject: Re: my bad displays habit
From: Lauren <lauren -at- writeco -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 26 Feb 2010 15:09:25 -0800

I try to address steps by what they will do, rather than what they have
done. So, I may write something like, "Click 'Edit Settings' to open
the 'Edit Settings' window," rather than "Click 'Edit Settings' and the
'Edit Settings' window displays."

Lauren


On 2/26/2010 2:25 PM, 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.
>

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

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: http://www.doctohelp.com

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:
http://www.ModernAnalyst.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:
my bad displays habit: From: Suzanne Chiles

Previous by Author: Re: Stupid Question of the day
Next by Author: Place punctuation inside or outside of quotes when writing software docs for English speaking Europeans in Europe?
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