11X17 documentation?

Subject: 11X17 documentation?
From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 25 Mar 2003 11:44:51 -0500


John Posada wonders: <<has anyone ever delivered finished documentation in
11X17 (17 across) format instead of 8-1/2X11?>>

Not as such, though I've produced smaller materials with foldout pages and
with "map pockets" at the back of a book.

<<My documentation contains a great deal of diagrams and tables.>>

Larger sizes may be a much better solution for this material. If that proves
not to be the case, but you're forced to place the material on smaller
pages, consider using a hierarchical series of diagrams--the print
equivalent of a zoomable image. For example, the first level in the
hierarchy might be a high-level overview of the large diagram (think
"airphoto"), with all the main components or modules clearly labeled in
large type. The next level, would be reached from the previous level by
means of a cross-reference (e.g., "This is the printer module. See page 37
for the expanded view.") and might represent a single module, enlarged again
to show its component parts but not necessarily the details. Those details,
if too small to be easily visible in this particular diagram, would be
consigned to a third level where each of the subcomponents is clearly
presented at an appropriate enlargement. Less efficient than a single large
drawing, but not as inefficient as you might think.

<<For pages that contain text, I would format the pages in two columns so
the line length doesn't get out of hand.>>

Two columns may not be enough, depending on font size, line spacing, etc.
Consider going to three columns if necessary.

<<The delivery format for this deliverable is HC and only internal, so aside
from finding binders this size, can anyone come up with issues other than
personal preferences?>>

Make sure you have a clear idea of where the docs will be used. For example,
none of my desks are large enough or sufficiently uncluttered for such large
pages to be usable, but if your readers are working on (say) uncluttered
drafting tables, the larger docs may not pose a problem. One significant
problem with larger docs is that they're floppy, particularly if the book is
at all thick; the greater weight of the paper keeps them folding over
themselves if not firmly supported (e.g., on a table). If the docs will be
held in someone's hands, use a sufficiently rigid cover that the pages
aren't constantly flopping around.

In terms of production issues, talk to your printer or service bureau to
make sure they can handle the paper sizes you're planning to use. Shouldn't
be a problem, but I've been surprised before. They may also have good advice
on production issues based on the combination of your software and their
hardware. Always worth talking to your printer in any event.

--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada

"Work is of two kinds: first, altering the position of matter at or near the
earth's surface relative to other matter; second, telling other people to do
so. The first is unpleasant and ill-paid; the second is pleasant and highly
paid."--Bertrand Russell

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: Update: Problem with single quotes and line wraps in Help files solved!
Next by Author: Common approach to documentation?
Previous by Thread: Re: Estimating a Project
Next by Thread: Index entries not updating in RoboHelp x3 printed docs


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


Sponsored Ads