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.
RE: Use of word "reference" when cross referencing
Subject:RE: Use of word "reference" when cross referencing From:Paul Hanson <twer_lists_all -at- hotmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 15 Aug 2018 13:11:33 +0000
I prefer to specify why the user would want to go read something else prior to naming the other place so I use this structure: "For more information about the system layout, see <hyperlink>Understand the System Layout</hyperlink>."
-----Original Message-----
From: techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Lin Sims
Sent: Tuesday, August 14, 2018 4:34 PM
To: TECHWR-L
Subject: Use of word "reference" when cross referencing
<snip>
I was taught to use "See section <section name> for more information." when the information is in the same document, and to use "Refer to <document name>" when the information is external to the document.
<snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com