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: Rhetoric And Technical Writing? From:mlist -at- safenet-inc -dot- com To:daveloveless -at- gmail -dot- com, bgranat -at- granatedit -dot- com Date:Wed, 22 Mar 2006 15:52:28 -0500
David Loveless talked about his radically different technical manual:
[...]
> I guess what I'm trying to say about boring is this: the people who
> have reviewed this manual READ the manual. They didn't just go look
> for information, nor did they read it because they had to. They READ
> the manual because they wanted to, and they enjoyed it. Why shouldn't
> our documentation be written in such a way that inspires reading?
Did I miss a post?
Where's the link?
I really want to see this manual of which you speak.
In fact, I'm surprised that all the other respondents let
this post and your previous one slide past without demanding
to see this paragon of engaging technical writing that you
have produced.
I guess it depends whether it's primarily task-oriented or
instructional. Isaac Asimov, in his non-fiction, used to
do a decent job of making tech-ish subjects accessible and
engaging, though I don't recall him ever really telling the
reader how to make or use... anything.
I'll be comparing your manual to a manual written for a
flow-charting program that I used years ago (was it
EasyFlow? ...can't be sure now... memory is spotty).
It was written in a humorous and folksy vein - not sure
if there was an actual techwriter involved, but at least
one of the programmers had a big hand in it (former skydiving
buddy and instructor who also had a humerous, folksy and
effective approach to teaching).
Anyway, let's have a look please. I promise not to steal it.
Kevin (reading and writing boring documentation in Ottawa)
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l