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

[Geoff Lane <geoff -at- gjctech -dot- co -dot- uk>]

On Monday, February 12, 2007, Char James-Tanny wrote:

> I see this as being two issues:

> - the engineer didn't look at the next page to see if the table was continued

We don't know this. It was well over a decade ago, so only the "big
picture" remains in my memory. However, the engineer might have
skimmed the manual and decided he only needed page 1, or he might have
photocopied both pages but only referred to the first on site. BTW,
the table didn't continue - the information did. I don't like tables
that span more than one page, and try to structure the information
into logical subsections, with one, smaller table for each.

> - the table didn't include warnings or other indicators stating that
> really important information was at the bottom (which ended up on the
> next page)

> The second doesn't mean that "continued" is the only solution.
> Numerous solutions could resolve the problem:

> - add a note at the top of the table that tells folks to read the
> entire procedure, which might be continued on the next page

The procedure wasn't in question. Several procedures could make use of
the data, and so the data was in a section of its own and each
procedure contained appropriate cross-references.

> - make sure the table prints on one page, not split across two. For
> example, add a page break before it. (Yes, one page will have more
> white space than folks would like. But that forces a decision between
> less white space or more danger.)

Ironically, and IIRC, this was one of the factors that led to the
misunderstanding. The data was organised into sections with one
section ending before the end of the page and I edited the copy to
insert a page break before the next table. IIRC, the engineer took the
white space to indicate the end of the data.

Now I'm a great fan of using copious amounts of white space to
organize content and to indicate document structure, but that can give
rise to issues as well as overcome them.

> - put an asterisk next to the torque values that have a warning (or
> add some other kind of indicator) so that folks look for the rest of
> the information.

I'm at a loss to see how the reader would see that asterisk, which
would be on a page he doesn't have.

> - add "continued on next page". (This one seems to require the most
> maintenance, though.)

As I said in earlier posts, if you need to say "continued from
previous page" at the top of the second page, you also need to say
"continued on next page" at the bottom of the first.

> There is no "one size fits all" solution here.

Agreed. However, that doesn't mean that use of continuation markers is
never appropriate (which is what the OP's initial rant suggested).
There are cases where they provide the least chance of
misunderstanding and the greatest chance of avoiding an expensive
and/or potentially fatal mistake.

JMHO,

-- 
Geoff

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

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 & 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- 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.