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: Department of Redundancy Department From:Keith Hood <klhra -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 10 Jul 2008 11:41:42 -0700 (PDT)
A perfect example of the fact that when you open a can of worms, the only way to stabilize the situation again is to use a bigger can.
--- On Thu, 7/10/08, technical writing plus <doc-x -at- earthlink -dot- net> wrote:
> From: technical writing plus <doc-x -at- earthlink -dot- net>
> Subject: RE: Department of Redundancy Department
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Date: Thursday, July 10, 2008, 3:16 PM
> I'm sure that you have cleaned it up better that I
> could. But still, I'm
> going to give you a glimpse into my thought process as I
> attempt to edit
> such a thing.
>
> Right, technically speaking, the facts may have been
> correct but technically
> speaking there was too many of them and reading such text
> gives people
> headaches.
>
> If I say 'Just plug it in' -- then the problem is
> that the reader might not
> know what I'm talking about.
>
> It does looks like I ought to use 'autosampler' and
> 'power supply' and 'back
> panel'. So here is my first real attempt to rebuild
> that sentence.
>
> [First, use the correct power supply.] Plug the [correct]
> power supply into
> the jack that is on [at] the back panel of the autosampler
> unit.
>
> Jim Jones zxlat.translatorscafe.com
>
> Technical Editing | Chinese, German, Spanish to English |
> Other
>
> -----Original Message-----
> Sam Beard presented
>
> ...revising a manual from before my time here, making some
> fairly
> minor edits. However, I ALWAYS review the manuals I'm
> revising here,
> reading them word for word, and I usually, if not always,
> catch some
> sort of error that wasn't in the set of redlines handed
> to me. Take this
> gem, for example:
>
> Plug the external desktop power supply cord of the
> voltage-specific
> external desk-top power supply supplied with the
> autosampler into the
> power connector located on the autosampler back panel.
>
> Now, this was step 1 of a four step process on plugging
> in an
> autosampler and connecting it to the main unit, in a
> section called
> Establishing External Connections. Right before this was a
> Warning and a
> Caution about using the supplied power supply. While not
> technically an
> error, isn't this a WONDERFUL example of technical
> writing?!
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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
>
> True single source, conditional content, PDF export,
> modular help.
> Help & Manual is the most powerful authoring tool for
> technical
> documentation. Boost your productivity!
>http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as
> klhra -at- yahoo -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/klhra%40yahoo.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.
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
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-