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: xref vs link From:"Tamminga, Ernie" <et -at- DSC -dot- COM> Date:Thu, 30 Oct 1997 14:19:31 -0800
My half-cents' worth:
In a hardcopy document, it can be annoying to keep running into
cross-references, because they interrupt the flow of what you're
Reading along, reading along, reading along (See such and such on page
so and so...). Reading along, (See such and such on page so and so...).
Reading along . . .
In an online document, a word or a phrase is a different color and/or
format to indicate a hyperlink, but no "extra" words are there to
interrupt the flow of the reading.
I say: online, use hyperlinks wherever you think the reader might need
or want some related information. In hardcopy, be very judicious
Or better, I guess: in ANY case be judicious, but "judicious" has
different quantitative value in each context.
Digital Sound Corporation
Opinions expressed are my own, and not necessarily those of Digital
>From: Joe Malone [SMTP:joe -at- VNETTECH -dot- COM]
>Sent: Thursday, October 30, 1997 3:14 PM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: xref vs link
>I wrote a hardcopy manual once and simply loaded it with
>cross-references, feeling proud that a reader could get anywhere they
>needed to go (the xrefs included page number). Reaction was negative.
>Now I'm preparing to do html files for a browswer. Figured I'd load it
>with referenced links between files. But will this still be a turnoff -
>should I duplicate lots of info to minimize jumping around? Compromise?
>Posts: mailto:techwr-l -at- listserv -dot- okstate -dot- edu
>Commands: mailto:listserv -at- listserv -dot- okstate -dot- edu (e.g. SIGNOFF TECHWR-L)
>Subjects: JOB:, QUESTION:, SUMMARY:, ANNOUNCE:, or none of these.