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: "Button Gravity" and "Warning Gravity" From:Laura Lemay <lemay -at- lauralemay -dot- com> To:techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 17 Dec 2008 11:43:00 -0800
On Dec 16, 2008, at 8:08 AM, Nancy Allison wrote:
> "The users who got electrocuted are going to be mad when they finally
> get to the warning!" That's what I always think!
I've told this story before, but I told it badly, so I'll tell it again.
A number of years ago I was taking apart a motorcycle with the help of
a Clymer manual. The Clymer manuals, for those of you who don't know
them, are maintenance and repair manuals for cars and bikes, with step
by step instructions and lots of photographs. They are not perfect.
They could be better. But sometimes they are all you have.
Specifically I was removing the cam chain, which goes from the bottom
of the engine to the top, and is connected by a removable ("master")
link. It had taken me about 40 steps just to get to that point, and I
had had to take off a whole lot of parts from the engine, which was
dirty and rusty and in very poor shape. I had reached the step at the
bottom of page 47 of the Clymer manual entitled "Removing the Master
Link."
The master link has a lot of pins and fiddly bits, and it is very
important that you not drop any of these bits into the engine, because
you can't get any of them out again without taking the whole thing
apart. So I was very careful as I pried the master link apart not to
drop any parts. I popped some parts across the garage, but no parts
went into the engine. Freed from the link, the two halves ends of the
chain slid apart. One side fell into the guts of the engine, but I
caught the other half. And I figured that was a success.
I returned to the Clymer manual, and turned the page. There at the
top of page 48, was a note.
Note: Make sure neither end of the cam chain falls into the crank case
by attaching wire to the ends before removing the master link.
*gasp*
I ranted for a good half hour on the importance of instructional
design, then kicked the bike twice and went inside and
got drunk.
And actually come to think of it I never did finish rebuilding the bike.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-