Re: Tech writer as "user"
The concept is exceptionally misleading, and widely taught in university classes in "technical writing." The fallacy is that the "user" is assumed to be witless and clueless, so a writer can dumb down basic material to sixth-grade level and call it "technical writing."
While I firmly believe that tech-writers need to know their material to do good work, I strongly disagree with this view of writing for the end-user.
First, one of the common ways that technical documentation fails is by making unconscious assumptions about the audience. It's far better to explain what seems to be obvious for you (and even for many of your readers) than to make these assumptions. This approach doesn't involve viewing the user as "witless and clueless" - just as someone new to the material, or who doesn't know as much as you on this particular subject. As I found out in grad school, while I have expertise in many areas, there are many more in which other people outshine me. As a result, I don't look down on anyone who doesn't have exactly my expertise.
Second, what you call dumbing down basic material to sixth-grade level I would simply call clear writing. When I was a university instructor, one of the first things I learned was that it was easier to teach a fourth year class, in which students had some idea of what I was talking about than to use the same concepts in a first year class. The same goes for tech-writing. The writer who can explain a subject in simple language is far more expert than one who abandones the audience to fumble along in his or her wake, desperately trying to grasp meaning.
Finally, in order to produce clear explanations, a writer has to understand the material. At times, trying to explain the material clearly can be a guide to understanding, especially if you're new to the material. However, if a writer can't explain something clearly and in simple words,then I question whether he or she really understands what they're trying to explain.I suggest that having expertise actually makes clear writing easier to produce, not harder.
Bruce Byfield bbyfield -at- axionet -dot- com 604.421.7177
"If blame is relative, then one of the important questions in society becomes: who controls the blame patterns?"
-Utah Phillips (in concert)
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
TECHWR-L is supported by ads and sponsorships...and donations.
You can help maintain the TECHWR-L community with donations
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
http://www.raycomm.com/techwhirl/ for more resources and info.
- Re: Tech writer as "user", Paul Strasser
Tech writer as "user": From: ASUE Tekwrytr
Previous by Author:
Re: Do I REALLY have to understand the material?
Next by Author: Re: Chapter Titles in Tech. Documentation
Previous by Thread: Tech writer as "user"
Next by Thread: Re: Tech writer as "user"
Search our Technical Writing Archives & Magazine