Best practices for hyperlinking in help?

[Hemstreet, Deborah]

 Hi Leonard,

I hyperlink the FIRST instance on each page, but not EVERY instance on
each page.

I hope this is helpful.

Deborah

-----Original Message-----
From: techwr-l-bounces+dhemstreet=kaydon.com at lists.techwr-l.com
[mailto:techwr-l-bounces+dhemstreet=kaydon.com at lists.techwr-l.com] On
Behalf Of Leonard C. Porrello
Sent: Tuesday, May 13, 2008 3:47 PM
To: techwr-l at lists.techwr-l.com
Subject: Best practices for hyperlinking in help?

In my on-line help, I have been using a hyperlinking convention
according to which I hyperlink only the first instance of a phrase. For
example, if "metadata catalog" appears several times in a help page, I
hyperlink (to the glossary) only the first instance of  "metadata
catalog". I've been wondering, however, if this is best. Because users
often read help pages topically (not from top to bottom), I am concerned
that they'll likely not notice a hyperlink to a glossary entry if there
is only one hyperlink at the top of a page. On the other hand, if I
hyperlink every instance of a phrase, the text often looks too cluttered
with links. I have a solution in mind, but I'd be grateful for any ideas
about best practices. 

Leonard C. Porrello

 

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

Create HTML or Microsoft Word content and convert to Help file formats
or 
printed documentation. Features include support for Windows Vista & 2007

Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as dhemstreet at kaydon.com.

To unsubscribe send a blank email to 
techwr-l-unsubscribe at lists.techwr-l.com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/dhemstreet%40kaydon.c
om


To subscribe, send a blank email to techwr-l-join at lists.techwr-l.com

Send administrative questions to admin at techwr-l.com. Visit
http://www.techwr-l.com/ for more resources and info.