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:Ron Hearn <rhearn -at- central1 -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 15 Aug 2018 16:39:54 +0000
Also using "please" changes an instruction to a request making it optional. Once I had to edit a draft from a BA that had a list of instructions starting with "Please" e.g. "Please enter your name", "Please enter your address", etc. Needless to say, the "please" didn't survive my edit.
-----Original Message-----
From: techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Wright, Lynne
Sent: August 15, 2018 7:27 AM
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>
Subject: RE: Use of word "reference" when cross referencing
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
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
This email and any attachments are strictly confidential, may be privileged, and are intended only for the use of the person(s) named above. Any other person is strictly prohibited from disclosing, distributing, copying or using it. If you are not the intended recipient (or are not receiving this communication on behalf of the intended recipient), please notify the sender immediately by return email or telephone call, and securely destroy this communication. Thank you.
Please reply to this message with "Unsubscribe" or "Unsubscribe All" in the subject line to unsubscribe from this mailing list or from all commercial electronic messages from Central 1.
If you choose to "Unsubscribe All", you will be removed from all future Central 1 electronic communications (e.g. texts; emails). If you want to stop receiving messages from this mailing list but want to continue receiving other messages from Central 1, reply with "Unsubscribe" instead.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
