TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
TOC article in INTERCOM -- things that made me go "HUH??"
Subject:TOC article in INTERCOM -- things that made me go "HUH??" From:"David Downing" <DavidDowning -at- users -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 13 Dec 2002 11:37:34 -0500
I just read the article "Designing a Table of Contents" in the November
2002 INTERCOM, and discovered a few things that gave me pause.
But first, let me say the article did have one good point. You should
construct your TOC as you're working on your document, not at the very
end, so that your TOC can serve as a guide to organizing your document
in the most useful, logical way, and creating the most useful, logical,
and consistent section headings.
The two points that made me go "HUH??" were
* A *recommendation* that I thought was an actual
*requirement* of a TOC by definition -- that the entries in the TOC
match, word-for-word, the section headings in the document. I always
took it as given that they *had* to match, except maybe for lengthy
headings that you want to truncate.
* A recommendation that seems to *contradict* a
requirement -- that you omit some headings at the chosen hierarchical
level from the TOC. I was always taught that you included all headings
at whatever level you chose. The only exception is maybe if the section
is short enough that they'd all be on one or two pages, or if there is
only one heading under a given heading at the next level up.
So what's going on here. Are my ideas about the TIC somewhat parochial
or what?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
---
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.
