RE: Principles for proceedure writing

Subject: RE: Principles for proceedure writing
From: "Gilger.John" <JGilger -at- acresgaming -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 7 Apr 2003 10:08:53 -0700

Fred Hone has some questions to those that prepare product
| instructional literature for the gerneral public on
| the list.
| Are there any specific rules that you follow when
| writing such literature and why?

1. Keep It Simple -- the sad fact of life is that many users cannot read above the eighth grade level.

2. Talk to the reader. Have a conversation with her/him. Anticipate questions and answer them. Leave the academic baloney in the old ivory tower. "You" is a good pronoun.

3. Active voice is good. Tell them what they want/need to know. Don't quibble, be clear and concise.

My $0.02

John Gilger
Senior Technical Writer
Acres Gaming, Inc.
Las Vegas, Nevada

Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here:

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Tech writer = office manager?
Next by Author: RE: Slightly off-topic but, I hope, not unwelcome
Previous by Thread: Re: Principles for proceedure writing
Next by Thread: RE: Principles for proceedure writing

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

Sponsored Ads