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: Do manuals have to be boring? From:"Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 27 Aug 2010 15:31:00 -0400
Kerschbaum writes: "If you've got a user guide or help system that you
want a reader to keep coming back to, making it entertaining could be a
smart move."
Actually, a smarter move would be to make a user guide or help system
that they don't *have* to keep coming back to. Good documentation
minimizes the user's reliance upon it.
My documentation isn't up on a stage, looking for attention; my
documentation is guiding the audience to their seats, and keeping the
dancers from falling into the orchestra pit.
-----Original Message-----
From: Craig Haiss
Sent: Thursday, August 26, 2010 10:15 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Do manuals have to be boring?
I found the following article inspiring, and it would be great with a
Friday morning cup of coffee.
"How a mouth-watering user guide got me thinking about technical
communication"
It made me long for the kind of computer manuals I read as a kid, when
computing was just a hobby and the authors of manuals were perfectly
willing to goof off in print.
This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at: http://lavacon.org/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-