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.
Subject:Re: Sam Clemens is dead From:John Russell <johnr -at- BRS -dot- COM> Date:Wed, 5 Oct 1994 13:39:46 EDT
> >Documentation should be simple and easy so as to make the huge monsters
> >we create manageable and less intimidating.
> To paraphrase Einstein, the support materials we provide with the "huge
> monsters" should be as simple as possible, but no simpler.
Another rhetorical tactic; twist someone else's words to fit your argument.
In any case, I'm sure Einstein was not talking about technical writing when
he said whatever it is he said. And besides, he can also be paraphrased as
saying: I want to know God's thoughts, the rest are details. So does he
want the complex details or doesn't???
> You can't simply ignore the complexity of the product because you'd like to
> have simple documentation--unless you're writing for ostriches. ...RM
Where did I say "ignore the complexity of the product"? I suppose because
the product is complex and convoluted that the documentation should be
complex and convoluted and difficult to use as well? So you seem to be
arguing. And besides, in a clear meta-phorical sense we often *are*
writing for "ostriches."
I'm sure you would agree that *despite* the complexity of the product, the
documentation which explains how to use it should be clear, precise, simple,
and easy to use. Certainly not complex and difficult. I would think that
this would apply to any kind of online help or tutorial as well as to a
hard copy manual. The final goal is the same, regardless of the medium:
MAKE THE DIFFICULT EASY.
Rich, I'm not arguing against *anything* you've said so far. I'm just
trying to find out what exactly it is you are trying to say.
---
kjr
johnr -at- lurch -dot- brs -dot- com
------------------------------------
|/ K. John Russell \|
| Dataware Technologies, Inc. |
| 5 Computer Drive South |
| Albany, New York 12205 |
|\ (518) 437-4025 /|
------------------------------------