TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Damien Braniff wrote:
> >> Perhaps not the best choice of words by Andrew, but as to the sentiment... I
> >> always remember some advice I was given when I first started writing (by a
> >> very senior writer and excellent mentor) - if you have no idea who your
> >> audience is then treat them as idiots, as if they know nothing about what
> >> you're writing. If they DON'T, then they'll be happy and get the info they
Which? Should you treat them as idiots _OR_ as individuals who know nothing
about your topic? There's a huge difference, and it's the difference
(in my case), between ruining a customer and keeping one.
> >> need. If they are much more experienced they may think the docs are a bit
> >> simple/condescending/whatever then they will skim read the docs and STILL
> >> get the info they need.
Do you _know_ this, or is this speculation? It sounds really good (and is
soothing
to tech writer's ears), but I'd like to see some usability studies that
verify or disprove it. I know that in my case, if I start glossing over
the "Choose File->Open, then in the Open Dialog box enter the name of the
file you want to open in the File Open field, then click Enter" information
(when "Open blah" would have sufficed), I usually end up missing the information
I really needed and have to reread three or more times to get it.
In the case of these particular docs, I grin and bear it, but if I'd purchased
a product or book, I'd be quite dissatisfied (and the person who wrote
the docs would squirm while watching me use them).