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:best wording for cross references From:kellyk -at- CYBEROPTICS -dot- COM Date:Wed, 27 Mar 1996 09:50:18 -0600
We don't have a style guide. We don't have enough consistency across
docs, as a result. One area is cross references. Here are some
examples I pulled:
A Turn to Leveling (ital) on page 18.
B For information on blah-blah-blah, refer to yadda-yadda-yadda.
C See "Solving Measurement Problems" on page 72.
Should a page number be included? Excluded?
One writer here prefers using example C. He feels 'Turn to' rhymes,
and that's not good. (I did explain that there was no rhyme; it was
actually the alliteration in 'Turn to' that he did not like.)
A third writer here uses example B.
What do your style guides say? What is your preference? Do any
reference materials you use deal with cross reference format?
Send responses to: kellyk -at- cyberoptics -dot- com
