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.
I was updating manuals for a company last year and I came across several
instances where sentences were left incomplete and other instances where it
would say something like, "The ABC screen (window, box, what do we call
this?)" were left in the manual. I asked them how them expected their
customers to read their manuals, when obviously their own staff didn't.
Several places where the company name and the product name were misspelled.
How about bone-head comments like "The Reverse Payment option is where you
can reverse a payment."
Weird stuff.
Suzette Leeming
Stouffville, Ontario
On 5/17/07, Van Boening, Tammy <tammy -dot- vanboening -at- fiserv -dot- com> wrote:
>
> So, I was the author of a hardware manual for a training class for a
> bunch of truck drivers years ago - seriously, the Hooters T-shirt, let's
> go to a strip club after work kind - and this made it through in the
> manual (to my absolute horror and to their absolute delight) -
>
> Instead of "tighten the wrench", it was "tighten the wench" - ah yes -
> that helped break the ice in the class. After something like that, I
> rarely get heartburn over a typo or two in a manual.
>
> TVB
>
> -----Original Message-----
> From: techwr-l-bounces+tammy -dot- vanboening=fiserv -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+tammy -dot- vanboening=fiserv -dot- com -at- lists -dot- techwr-l -dot- com]
> On Behalf Of Combs, Richard
> Sent: Thursday, May 17, 2007 3:00 PM
> To: Connie Giordano; Michelle Vina-Baltsas; techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Finding errors in manuals
>
> 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 ;-)
>
> Well, it sure looks funny, but it's not necessarily _wrong_.
>
> After all, we Windows users click Start to quit. ;-)
>
> Richard
>
>
> ------
> Richard G. Combs
> Senior Technical Writer
> Polycom, Inc.
> richardDOTcombs AT polycomDOTcom
> 303-223-5111
> ------
> rgcombs AT gmailDOTcom
> 303-777-0436
> ------
>
>
>
--
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 & 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 & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-