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.
Hello, my opinionated colleagues (and I mean that in the best
possible way ;-)
I have a question about hyperlink style.
Background: We provide online books in PDF form. No hardcopy.
Sophisticated audience. We have no existing style guideline for
Per convention, our hyperlinks are in blue so they are easily-
recognizable. However, we are still using hardcopy x-ref conventions
also -- putting section titles in quotes and providing page numbers.
Dilemma: The blue text, quotes, and page numbers seem like
overkill. Our audience is used to online stuff -- should we just
use the blue text and get rid of the quotation marks and page
numbers? (since they can just select the link and go to that
section) Or should I keep them in there for the one or two users
who might print the darn thing out?
'To create a process' on page 16 <with section title in hyperlink blue
To create a process <in hyperlink blue text>
I prefer the second -- it's simpler and cleaner. My audience tends to
the docs online, rather than printing them out. Any good reasons for
the quotation marks and page numbers? Is the possibility that it might
printed out a good enough reason to keep 'em?
Senior Technical Writer
Seagate Software mailto:alexiap -at- sems -dot- com