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:"Wright, Lynne" <Lynne -dot- Wright -at- Kronos -dot- com> To:Syed Zaeem Hosain <Syed -dot- Hosain -at- aeris -dot- net>, 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 14:26:32 +0000
I'd never use "please" as part of a statement that tells the reader what to do. It doesn't add clarity; its just clutter.
I don't know about the rest of you, but aside from being unnecessary, when I read "please" as part of an instruction, I actually find it a little smarmy.
-----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 Syed Zaeem Hosain
Sent: Wednesday, August 15, 2018 9:46 AM
To: 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
I use "See section ... ", but "Reference section ..." is correct grammar, even if little used.
For a compromise, how about "Refer to section ... for more information"? Still clumsy in my opinion, but may assuage the co-worker.
Sometimes, a polite "Please reference section ... " may also be clearer?
Z
-----Original Message-----
From: techwr-l-bounces+syed -dot- hosain=aeris -dot- net -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+syed -dot- hosain=aeris -dot- net -at- lists -dot- techwr-l -dot- com> On Behalf Of Lin Sims
Sent: Tuesday, August 14, 2018 2: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.
We really need a style guide.
--
Lin Sims
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
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
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
