RE: Table that spreads over multiple pages

Subject: RE: Table that spreads over multiple pages
From: "Jones, Donna" <DJones -at- zebra -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 6 Aug 2004 09:45:45 -0500



-----Kimberly Thornton wrote:-----

I have inherited a military technical manual to update. I've come across a
troubleshooting table that spreads across 33 pages!!!!! Just one table! Its
a three-column table that lists the Symptom, Probable Cause, and Corrective
Action.
<snip>
Has anyone else dealt with this type of issue? How did you handle it?
------------------


There was a similar situation with some of the troubleshooting tables in the
user guides I took over. Some of the older guides threw all of the
troubleshooting issues together, making it necessary for the users to muddle
through pages and pages of issues to try to find one that might apply to
them.

What worked for our user guides was to group the different symptoms
logically and split the table apart based on those groupings. I inserted
level 1 headings between the tables to break things up and show clearly
where the tables started and stopped. The table caption was the same as the
text of the heading, and if a table split across pages, the table caption
included the word Continued.

For example, because we work with printers, we were able to break down the
one table into the following logical groupings:
- LED Error Messages
- Print Quality Problems
- Calibration Problems
- Communication Problems

I would suggest reading through the issues listed in your huge table to see
if there are ways that you can group some of them so they can be split off.
Any that remain that don't fit in a category could always be left together
in one table with the heading "Miscellaneous Issues."

Hope that helps!
Donna

Donna L. Jones
--------------------------------------
Technical Writer II
Zebra Technologies Corp.
Vernon Hills, IL
djones -at- zebra -dot- com


- CONFIDENTIAL -
This email and any files transmitted with it are confidential, and may also
be legally privileged. If you are not the intended recipient, you may not
review, use, copy, or distribute this message. If you receive this email in
error, please notify the sender immediately by reply email and then delete
this email.


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

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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: RE: ADMIN: An Open Letter to the TECHWR-L Community
Next by Author: RE: A New Approach?
Previous by Thread: RE: Table that spreads over multiple pages
Next by Thread: FM 7.1 and AutoCAD files


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


Sponsored Ads