Re: Most illogical documentation

Subject: Re: Most illogical documentation
From: "Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com>
Date: Fri, 29 Jun 2007 15:59:21 -0400

I am augmenting (rewriting for our users) some HUD instructions today.

So, the most current example that I have is the HUD form instructions
that say:

- Enter the (blah blah) number in Section 3 - box 3b.

That number comes from Section 4, box 4g. The user has not even done that
section yet. So how can they enter it into Section 3? <sigh>

Aye Yi Yi!! That's only ONE example of the convoluted non-logic in the
existing instructions, and the cause of my headache this afternoon!

TGIF!!!


PT


On 6/29/07, cupton -at- syclone -dot- net <cupton -at- syclone -dot- net> wrote:
>
> I once worked with someone who always included three tables in his
> installation manuals:
>
> - Standard Options
> - Optional Options
> - Custom Options
>
> TGIF
> Carolyn
>
> > This seems a Friday-ish topic for tech writers.
> >
> > What is the most illogical bit of tech writing you've seen?
> >
> > The earliest, and still one of the best, that I've come across was a
> > passage about how to open the box. You could only have opened the manual
> > if you had opened the packing box beforehand. (Manuals were not handed
> out
> > like candy by the sales people, either -- too expensive. So really,
> > honestly, if you were reading that page, you'd already opened the box.)
> >
> > It even had a picture of the flaps of the box being opened and an arrow
> > showing that the stuff had to come UP out of the TOP of the box, which
> is
> > where the flaps were OPEN.
> >
> > Naturally, I personally have never written anything quite that
> illogical,
> > not even under duress! I swear!
> >
> > --Nancy
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > 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 cupton -at- syclone -dot- net -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/cupton%40syclone.net
> >
> >
> > 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 pro -dot- techwriter -at- gmail -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/pro.techwriter%40gmail.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.
>
>


--
PT
pro -dot- techwriter -at- gmail -dot- com
I'm a Technical Technical Writer!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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:
Most illogical documentation: From: Nancy Allison
Re: Most illogical documentation: From: cupton

Previous by Author: Re: Nuts.
Next by Author: RE: Word's "Master Document" feature
Previous by Thread: Re: Most illogical documentation
Next by Thread: Re: Most illogical documentation


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


Sponsored Ads