There is a persistent belief in the TW community that the average user is
inexperienced and ignorant of the product they have bought. I suppose this
is a product of the late lamented tech boom when we were all suddenly buying
and using our first word processor, our first spreadsheet, etc. But it is
not the normal state of things. People mostly buy things of a type they are
familiar with, whose functions and use they know well.
The myth of the ignorant editor and the myth of the ignorant writer are both
derived from the myth of the ignorant user. . . .
There's ignorance and ignorance. I document APIs. I spent the first
half of my career as a programmer, and the second half now as a writer.
I always try to assume my API-user audience knows how to program,
knows how to use an API, but is (largely) ignorant about the API
under discussion and the specific system that this API connects to.
What would I, as a programmer, need to know about the software system
in order to effectively use the API?
When I documented COBOL for Tandem, I tried to think like a programmer
who knows IBM mid-size or mainframe systems, but did not know about the
peculiar architecture of Tandem NonStop systems. IBM talked about link
editing, where Tandem talked about binding. I made sure the index had
an entry "Link edit, see Binder".
We need to be aware of that kind of ingnorance in our readership.
Guy K. Haas
guy -at- hiskeyboard -dot- com | gkhaas -at- usa -dot- net & http://guy.blogs.at
Software Exegete in Silicon Valley
Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.
Order RoboHelp today: http://www.ehelp.com/techwr-l
ATTENTION FrameMaker Users: Fill-out the following survey to receive a chance to win a FREE RoboScreenCapture.
FM users only please: http://www.ehelp.com/techwr-2
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: huh?: From: Mark Baker
Search our Technical Writing Archives & Magazine