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.
...agree with Lynne. What I was taught is that a "proper noun" is a person/place/thing that is ALWAYS capped: America, Jesus Christ, Thanksgiving, Porsche, Disneyland. That's why they're "proper" (unique names).
A label (name) is also capped. So, if there is a label named External Port, then cap it as such in the documentation; if External only, then state "...the External port."
And, yeah...you don't tell them how to engineer; they don't tell you how to write. (If they push it, show them one of the major style manuals.)
________________________________
From: techwr-l-bounces+deboraames=hotmail -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+deboraames=hotmail -dot- com -at- lists -dot- techwr-l -dot- com> on behalf of Wright, Lynne <Lynne -dot- Wright -at- Kronos -dot- com>
Sent: Wednesday, June 8, 2016 12:46 PM
To: Jim; techwr-l
Subject: RE: To capitalize or not?
I say nope!
Aside from the fact that if you start using initial caps for every object you write about, Your Instructions Will Starte To Looke Like An Olde Englishe Style Manuscript, I'd say that ''external port'' is pretty much a generic term for a port that ...well, you know. And therefore, no capitalization on either term.
Even if the engineers' have a point about it being a quasi-proper noun -- say if the port on the hardware is actually labelled ''External'', ok, capitalize ''External'', but definitely no cap on ''Port'' -- which again, is a generic thing, not really part of the object's title, if you will.
Finally, you're the writer -- you're the language expert; its up to you to define the rules regarding writing style issues. Not the engineers.
-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Jim
Sent: 8 juin 2016 15:07
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: To capitalize or not?
I'm having this ongoing debate with my engineer coworkers: when to capitalize the names of the parts that make up our hardware platform. I'm describing a server we manufacture for telecom networks. On the back of the server are various ports and plugs. I am providing instructions for connecting a specific cable to a specific port, which we call the "external port."
Question: should reference to this specific port be capitalized (External
Port) or not (external port). My engineer coworkers say yes because we are referring to a specific port so this is a type of proper noun. All the other ports on the server have specific names so these should also be capitalized. I'm not sure this does qualify as a proper noun. Thoughts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
