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:"Alan Salo (Ariens Plant 1)" <asalo -at- ariens -dot- com> To:Slager Timothy J <Timothy -dot- Slager -at- dematic -dot- com>, "Wright, Lynne" <Lynne -dot- Wright -at- Kronos -dot- com>, Lin Sims <ljsims -dot- ml -at- gmail -dot- com>, TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 15 Aug 2018 13:22:06 +0000
Our style is to use "See figure xx" when we reference within the manual and "Refer to xx" when the reader is to leave the current manual and access another.
Alan
-----Original Message-----
From: techwr-l-bounces+asalo=ariens -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+asalo=ariens -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Slager Timothy J
Sent: Wednesday, August 15, 2018 7:59 AM
To: Wright, Lynne <Lynne -dot- Wright -at- Kronos -dot- com>; Lin Sims <ljsims -dot- ml -at- gmail -dot- com>; TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: RE: Use of word "reference" when cross referencing
@ Lynne
"Reference" as a verb is grammatically correct, but it means something else, according to Merriam-Webster. It means to supply references or to cite as a reference, not "refer to." If you have a source that says otherwise, I think Lin would like you to cite it. Out of curiosity, so would I.
tims
-----Original Message-----
From: techwr-l-bounces+timothy -dot- slager=dematic -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+timothy -dot- slager=dematic -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Wright, Lynne
Sent: Wednesday, August 15, 2018 8:49 AM
To: Lin Sims; TECHWR-L
Subject: RE: Use of word "reference" when cross referencing
Using "reference" as a verb is grammatically correct; but to me, its too formal, clunky, and outdated.
Why say "reference section x for more information" when "see section x for details"; or even just "see section x" is less formal/more modern, and complies with the tech writing principle of "shorter and simpler is better"?
-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Lin Sims
Sent: Tuesday, August 14, 2018 5:34 PM
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Use of word "reference" when cross referencing
Has anyone seen any manual that uses the word "reference" when referring to material that is in another location? As in, "Reference section <section
name> for more information."
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.
Every time I see "Reference <section name>", I come to a screeching halt.
My co-worker insists this is proper usage, but I just can't get my mind around it.
References (heh) to correct usage would be appreciated. I've been looking but so far I can't find ANYTHING that addresses this.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
