RE: naming methods in manuals

Subject: RE: naming methods in manuals
From: "Dia Blankenship" <dia -at- teknolutionary -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 26 Mar 2001 14:36:03 -0500


> >If documentation is on-line, any Short name can be hyper-linked
> to the Long
> >name. Actually, all instances of the name (short or long) can be
> >hyper-linked to the same glossary reference that explains all.
>
> While it is true that every instance of a word CAN be linked to a
> gloss, you should carefully consider whether this is a good idea
> from a readability perspective. Blue measles will distract the
> reader from the information content of what you are trying to
> convey. At most, I would include one hyperlink per page for a
> given term, such as the product name, that is likely to be used
> more than once per page. An alternative is to include an
> unobtrusive footer or sidebar on every page that includes links
> to all the glossed terms on that page.


Why not try a hybrid of a couple of answers and hyperlink the first
reference on each HTML page. That way you get the info on the first
reference without hyperlinking till you're blue in the face.

-D


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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

---
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: RE: Acronyms revisited...
Next by Author: RE: No Subject
Previous by Thread: Re: naming methods in manuals
Next by Thread: Re: naming methods in manuals


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

Sponsored Ads


Sponsored Ads