RE: Best practices for hyperlinking in help?

Subject: RE: Best practices for hyperlinking in help?
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
To: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 13 May 2008 14:49:59 -0700

I agree that shorter pages are better. Ideally, any given task would fit
in the viewable area of a single page displayed in a web browser sized
to 800x900 (or fewer) pixels. However, writing to do so would break
apart work flows illogically.

A user would jump into the middle of a page when, for example, searching
for the meaning of or permitted values for a give field within a
workflow. He would access the field via a link to field in the index. It
would be silly to force a user who is interested in only one field to
start at the top of a page/workflow.

Leonard C. Porrello


-----Original Message-----
From: Combs, Richard [mailto:richard -dot- combs -at- Polycom -dot- com]
Sent: Tuesday, May 13, 2008 1:27 PM
To: Leonard C. Porrello; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Best practices for hyperlinking in help?

Leonard C. Porrello wrote:

> 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.

But YOU control whether (and where) readers can jump into the middle of
a page. You also control the length of the pages.

Personally, I'd rather be presented with shorter pages -- or, if a topic
simply must be lengthy, a link to the top, not the middle -- instead of
seeing scores of hyperlinks to the same handful of glossary items.

IMHO, YMMV, etc.

Richard


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------








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

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-

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%40web.techwr-l.com


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

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


References:
RE: Best practices for hyperlinking in help?: From: Hemstreet, Deborah
RE: Best practices for hyperlinking in help?: From: Leonard C. Porrello
RE: Best practices for hyperlinking in help?: From: Combs, Richard

Previous by Author: RE: Tool to create interactive demos?
Next by Author: RE: Definition of Tech Writer, was STC is broken
Previous by Thread: RE: Best practices for hyperlinking in help?
Next by Thread: Thanks to Everyone for Laptop Advice


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

Sponsored Ads


Sponsored Ads