spell it out a second time within 4 pages, or cross-ref?

Subject: spell it out a second time within 4 pages, or cross-ref?
From: "Genevieve Roberts" <gen -at- qrtz -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 4 Dec 2002 13:17:29 -0800

Bear with me, please, as I try to explain a problem of repetitions, because
the explanation is repetitious.

I have a number of dialog boxes to explain that have the same search

For example:

In the Select Job dialog box, the user can search on Active & Pending Jobs
or Done Jobs.

This dialog box opens to a custom search form if the user selects the Custom
radio button. In the custom search form, the user can choose Active,
Pending, Done, or Closed jobs upon which to search.

I have the same kind of repetition for Tasks, Sessions, Samples and Images.

There is a massive amount of conditional text among the instructions for
using these boxes.

I would like your opinions on the best way to write for the boxes.

Would you define Active Job on, say, Select Job on page 441, and Custom
Search Select Job on page 444, put a cross-reference to only the page number
441? Or, given that it's a one-line definition, would you consider it more
convenient for the reader to have the definition presented?

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.

Previous by Author: Search engines recognising special characters?
Next by Author: OT: free ticket to STC Vancouver BC Christmas dinner
Previous by Thread: RE: So...ya wanna be noticed, huh?
Next by Thread: RE: spell it out a second time within 4 pages, or cross-ref?

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

Sponsored Ads