RE: Cross Referencing/first timer

Subject: RE: Cross Referencing/first timer
From: "Mike Bradley" <mbradley -at- techpubs -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 14 Nov 2002 11:34:42 -0800


> I think I should have some clear guidelines before
> undertaking this. What say you?

I used to put a complete description in my cross-references. Then, after
I "converted" to minimalist documentation, I asked myself, "What does
the user need to know in order to find the reference?" I decided that
s/he generally needs nothing more than the page number. Occasionally, a
more specific reference is necessary, say when there are two short
tables on the same page.

= Mike Bradley
Tech Pubs



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in November 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.


References:
Cross Referencing/first timer: From: dan . gallagher

Previous by Author: RE: In the Trenches, A Bit of Venting
Next by Author: RE: Anyone ever heard of this book or program]
Previous by Thread: Cross Referencing/first timer
Next by Thread: Re: Cross Referencing/first timer


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


Sponsored Ads