[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Rant continued from previous page (was Re: Another Word guru question)

Subject: Re: Rant continued from previous page (was Re: Another Word guru question)
From: "Kathleen MacDowell" <kathleen -at- writefortheuser -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 10 Feb 2007 21:43:56 -0600

This does not apply to documents that require certain information,
regardless of the length:

Currently I deal with electronics, which can have specifications that run on
at length. Preferring tables one page at the most, I ask the interested
parties to tell me which specs are necesssary. Usually I end up with a table
at most one page.

In the same vein, if faced with a longer table, I try to determine if there
was some reasonable way to break it into two or more tables, meaning is
there some organizing principle that could be used for two tables instead of
one. I'm fortunate to be able to end a page early, so it would work out
fine.

Just a suggestion.

Kathleen

On 2/10/07, Geoff Lane <geoff -at- gjctech -dot- co -dot- uk> wrote:


Please excuse the rant, but this topic is related to an incident that
could have cost one of my readers his life. The data in question gave
torque settings that were a default value unless otherwise specified,
and torque for a critical fastener was on the second page.

On Saturday, February 10, 2007, Mike Starr wrote;

> Why on earth do we need to add "Continued..." to the top of each
> additional page?

We need to add "Continued" to the top of each additional page to show
that it's incomplete. For that, we need to add "continued/.." at the
bottom of a page that is continued, and "../continued" at the top of
the continuation page so that the recipient of either page knows he's
not seeing the whole picture.

> Do we think they're not going to turn the page and that the table
> having the same headings on both pages is not going to clue them in
> to the concept that there was too much stuff to fit on one page?

Unless no harm can come from a reader seeing only one of the pages, we
need to do it because the reader might not have access to both pages.
For example, if one page was printed from a PDF, or even a photocopy
of something only available to our audience in hardcopy. Now I've had
technical data for machinery misinterpreted from one of my manuals
because of this issue - and only by good fortune it wasn't fatal. Ever
since, I've used continuation markers unless the customer demands I
don't and is prepared to put that instruction in writing.

> And if our readers are such clueless bowbs are they really the
> target audience we want/need to serve? ... And no, I'm not picking
> on Nancy in particular but on the misguided portion of the technical
> writing community that seems to think this sort of thing is worth
> spending time trying to accomplish.

We often can't pick our audience and if our tech writers are such
arrogant and myopic bowbs to believe that such devices are never
necessary ...

... and FWIW, I do think that time spent arranging my documents to
avoid possibly fatal misinterpretation is time very well spent.

(rant over)

--
Geoff

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

--
Kathleen MacDowell
www.writefortheuser.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. 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- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.

References:
Rant continued from previous page (was Re: Another Word guru question): From: Mike Starr
Re: Rant continued from previous page (was Re: Another Word guru question): From: Geoff Lane

Previous by Author: Re: Singular or Plural?
Next by Author: Re: Need a word!
Previous by Thread: Re: Rant continued from previous page (was Re: Another Word guru question)
Next by Thread: RE: Rant continued from previous page (was Re: Another Word guruquestion)

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads