Re: too many hyperlinks in a topic?
I'm reviewing a (java)help document that has been critised as having
excessive hyperlinks in each topic, such that readers are easily
diverted and become 'lost' from the original topic that they were
reading.
A silly question, I admit, but is there is consensus or general rule
of thumb as to what consititutes "excessive hyperlinks"?
Earlier this week, I emailed someone who said she worked on Borland's
online help to ask her if she was at all responsible for the overview
topics in the online help for Delphi 3. They were heavy with links,
taking you to more detailed explanations of each of the overview
topics that were being briefly covered in the overview topic. I LOVED
those topics, as they gave me a starting point that centered around a
single topic; the links were frequently were all over the place in the
TOC (I guess it was more like an index than a table of contents in
that regard). I have created the same kind of link-heavy overview
topics in online help that I've written for more than one product.
That said, I can see where you might not want to have a bunch of links
in, say, a procedural topic. You don't want readers to move to a new
topic while they're in the middle of a set of steps. In those topics,
you might consider moving the links down into a See Also section at
the bottom of the topic.
--
-David Castro
thejavaguy -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
References:
too many hyperlinks in a topic?: From: e-letter
Previous by Author:
Re: Music choices
Next by Author:
Re: Training technical writers
Previous by Thread:
Too many hyperlinks in a topic?
Next by Thread:
Re: too many hyperlinks in a topic?
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads