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.
Subject:RE: Best practices for hyperlinking in help? From:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:"Hemstreet, Deborah" <DHemstreet -at- kaydon -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 13 May 2008 13:17:43 -0700
My thinking has been along the same lines. However, I am concerned for
the reader who jumps into the middle of a page and misses the hyperlinks
at the top of the page.
Leonard C. Porrello
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Hemstreet, Deborah
Sent: Tuesday, May 13, 2008 12:55 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Best practices for hyperlinking in help?
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 -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+dhemstreet=kaydon -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Leonard C. Porrello
Sent: Tuesday, May 13, 2008 3:47 PM
To: techwr-l -at- lists -dot- techwr-l -dot- 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.
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 -dot- com -dot-
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
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
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 archive -at- web -dot- techwr-l -dot- com -dot-
