[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Syntax preferences

Subject: Re: Syntax preferences
From: Al Geist <al -dot- geist -at- geistassociates -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Aug 2005 09:14:31 -0400



I've made my person policy to use the second example whenever possible. It gives better flow to procedures, especially long ones.

Al

Broberg, Mats wrote:

Dear all,

In a one-sentence step in a procedure, do you prefer to start the
sentence with the result, or with the action to achieve the result? I
need to decide on a general policy in our documentation.
An example:

- To adjust focus, turn the ring.

- Turn the ring to adjust focus



--

Al Geist, Geist Associates
From Concept to Completion
Technical Writing, Online Help Applications, Marketing Collateral, Web Design, Award Winning Video, Professional Photography
Office: 802-658-3140

Cell: 505-400-4128
E-mail: al -dot- geist -at- geistassociates -dot- com <mailto:al -dot- geist -at- geistassociates -dot- com>
URL: www.geistassociates.com <http://www.geistassociates.com>
URL: www.geistassociates.com <http://www.geistimages.com>

"When the situation is absolutely hopeless, you have nothing to worry about."
Compliments of The Monkey Wrench Gang



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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l


---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
Syntax preferences: From: Broberg, Mats

Previous by Author: Re: Digital Voice Recorder (DVR )
Next by Author: Re: Syntax preferences
Previous by Thread: Syntax preferences
Next by Thread: Syntax preferences?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads