Re: If You Were Gonna Teach...

Subject: Re: If You Were Gonna Teach...
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 7 Mar 2002 08:36:26 -0800 (PST)

Ignore grammatical issues. Most readers can interpret
beyond bad grammar.

Instead, I'd focus the importance of documenting
things completely. Most of my frustration is working
with insufficient information. For example, tech
writers complain about trying to write good release
notes from bug reports that are incomplete. I'd
explain that it's better to be thorough in their
writing, never assuming that their readers know as
much as they do.

I'd provide several examples and discuss how they'd
improve the information. Dare I suggest it, but you
could even assign "pre-work." Ask them to write
procedures for making a peanut butter and jelly
sandwich and then try to actually make a sandwich in
class using their instructions.

Steven Brown
Senior Technical Writer

Do You Yahoo!?
Try FREE Yahoo! Mail - the world's greatest free email!

Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.
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.

If You Were Gonna Teach...: From: Tom Murrell

Previous by Author: Re: Technical subjects: What do you want to know more about?
Next by Author: Re: If you were going to learn...
Previous by Thread: RE: If You Were Gonna Teach...
Next by Thread: Re: If You Were Gonna Teach...

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

Sponsored Ads