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.
RE: TOC article in INTERCOM -- things that made me go "HUH??"
Subject:RE: TOC article in INTERCOM -- things that made me go "HUH??" From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 13 Dec 2002 12:58:23 -0500
In this example...it was shortened. However, that isn't the criteria upon
which the change should be made, just this example, even if it was a poor
one. The criteria is that if it is better when different, then make it
better...if it cannot be made better, then don't do it.
Would you rather have a hard and fast rule that says "NEVER MAKE THE TOC
ENTRY DIFFERENT THAN THE HEADING" even if it would be better for the user?
Sounds similar to "A PUNCTUATION MARK ALWAYS GOES INSIDE OF THE QUOTATION
MARK", or how about this one..."ALWAYS PUT ONE SPACE AFTER A PERIOD".
-----Original Message-----
From: Jeff Hanvey [mailto:jewahe -at- lycos -dot- co -dot- uk]
Sent: Friday, December 13, 2002 12:48 PM
To: John Posada; TECHWR-L
Subject: Re: TOC article in INTERCOM -- things that made me go "HUH??"
My feelings are if you're going to spend the time to "shorten" the TOC
entry, seeing it as perhaps "better," then you should shorten the actual
heading. Even changing from "Configuring the Email Server" to "Email Server
Configuration" can be confusing to the reader, so I *always* make the TOC
entries match the actual headers.
Jeff Hanvey
Augusta, GA
jewahe -at- lycos -dot- co -dot- uk http://www.jewahe.net
----- Original Message -----
From: "John Posada" <JPosada -at- book -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Friday, December 13, 2002 12:34 PM
Subject: RE: TOC article in INTERCOM -- things that made me go "HUH??"
> Sometimes, it's hard to see the point for the trees...huh?
>
> Let me try to address my feelings about this TOC issue..
>
> I don't think a TOC MUST be word for word since the content of the TOC
> must stand alone and understanding the heading it reflects may be
> helped by the content that immediately precedes and follows. If the
> wording of the TOC can
> be adjusted so that it gives a better understanding, then I don't have a
> problem with it. At the same time, it must be close enought to the
> information it reflects so that when someone goes to the page, they don't
> think they are in the wrong section.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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!
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
---
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.
