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.
> 1. For "print style" documents such as PDF, it is certainly better to tell the
> reader to "see section 1.2.3" rather than "see Attaching Thingamabobs to
> Doohickeys" or even "see page 1-23". <snip>
I beg to differ. I have no idea where in the book section 1.2.3 may be. (Well, OK, I could guess that it might be near the front. But does section 1.2 contain 20 subsections covering 20 pages or 3 subsections covering 120 pages?)
Assuming continuous (not folio) page numbering, I can pretty accurately estimate where in a 300-page book page 123 falls.
> 2. For Web documents it goes the other way. It makes much sense to say "see
> here", where "here" is a character formatted hyperlink. <snip>
Usability professionals have been arguing against the use of "here" as hyperlink text for years. It's much better if the link text provides meaningful content, such as the destination heading title or a phrase describing the destination.
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.