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.
This is really not a question of either consistency or capitalization. It is
a question of whether things have names. If they have names, the rules about
capitalizing those names are clear. If they don't have names, or if you
choose to refer to a named thing by type rather than name, the rules are
similarly clear.
The issue is, does the port in question have a name, and if so, what is that
name. Answer that question and then follow the capitalization rules
appropriately.
The one exception to this would be that if the interface gets it wrong (and
you can't get it fixed, which should be the first thing you try), then it
will make things clearer for the reader if you follow the interface.
Where inconsistencies tend to arise in these matters is when people ask the
wrong questions and base their answers on the wrong principles. If you are
arguing about whether a thing should be capitalized, or whether
capitalization should be consistent, when you should be arguing about
whether a thing has a name, you are likely to come up with inconsistent
answers, and thus inconsistent results.
The question is, does the port have a name. Everything follows from that
using well established rules. And only the company that builds the machine
can decide whether or not it wants to name that port. But if it does, it
should use that name consistently.
Mark
-----Original Message-----
From: techwr-l-bounces+mbaker=analecta -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+mbaker=analecta -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Keith Hood
Sent: Thursday, June 9, 2016 12:59 AM
To: Jim
Cc: techwr-l
Subject: Re: To capitalize or not?
In the absence of any more compelling argument, just maintain consistency.
If the other port names are capitalized, then capitalize this one as well.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
