Re: Finding errors in manuals

Subject: Re: Finding errors in manuals
From: "Suzette Leeming" <suzette -dot- leeming -at- gmail -dot- com>
To: "Jeff Hanvey" <jewahe -at- comcast -dot- net>
Date: Thu, 17 May 2007 20:08:28 -0400

Last year I broke my right wrist quite badly. Since we had a new release
coming out and were pushing to get the documentation done (I'm a lone
techwriter), I insisted on continuing to work, from home, on my laptop
(touchpad was easier to work with my left hand than a mouse).

Unfortunately I was on serious painkillers at the time (I had to have the
wrist operated on and 3 pins put in to hold it). When I finally came out of
my drug haze I came across the stupidest things that I'd written.
Fortunately, I was blessed with a sense of humour and just made sure to
review everything I had written and send new PDF copies to our customers.

Stuff happens. We want to be perfect, but very few of us are.

Suzette Leeming
Stouffville, Ontario

On 5/17/07, Jeff Hanvey <jewahe -at- comcast -dot- net> wrote:
>
> Connie Giordano wrote:
> > I literally just came across this in a manual I'm editing right now:
> >
> > "Press <ENTER> to exit:" Hope that makes you feel better ;-)
>
> Our product is made up of multiple application. Each application is
> named using a common prefix and an abbreviation indicating the purpose
> of that application. One of these applications is a security
> application, and it is therefore named "ProdSec" (well, not exactly).
>
> I now know just how close the "C" and "X" keys are on the standard
> keyboard. I now do a global search on that certain term.
>
> Luckily, the doc has never gone out with that particular mistake,
> although there have been a couple of close calls.
>
> --
> JWH
>
> --
Need affordable web hosting? I recommend 1 & 1 - that's where I'm hosted!
http://www.1and1.com/?k_id=6815038
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
Re: Finding errors in manuals: From: Connie Giordano
Re: Finding errors in manuals: From: Jeff Hanvey

Previous by Author: Re: Most embarasssing error (was Finding errors in manuals)
Next by Author: Re: Most embarasssing error (was Finding errors in manuals)
Previous by Thread: Re: Finding errors in manuals
Next by Thread: RE: Finding errors in manuals


What this post helpful? Share it with friends and colleagues:


Sponsored Ads