Re: Capitalizing product names of product features

Subject: Re: Capitalizing product names of product features
From: Keith Hood <klhra -at- yahoo -dot- com>
To: "salt -dot- morton -at- gmail -dot- com" <salt -dot- morton -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 29 Nov 2016 16:46:03 +0000 (UTC)

Capitalize the words only if you're drawing attention to something the user can see on screen. Never capitalize generic references.

If you write something like "Enter a valid address in the Email Address field..." you capitalize the name of the feature. In that case you're pointing at something.

But when you write about something that is not actually part of the UI, like "You must have a valid email address in order to..." you're not pointing out an actual screen landmark. In this case, the email address is a concept, not a feature. References like these should be lower case.


On Tuesday, November 29, 2016 9:38 AM, Chris Morton <salt -dot- morton -at- gmail -dot- com> wrote:


How does the item appear in the actual user interface (UI)? That is exactly
how it should be referred to in the text â errors and all.

Take This button example... the instruction should read, Click *[This
button]*.

In another chapter, and referring to another portion of the UI, the button
is labeled This Button

The instruction should now read, Click *[This Button]*.

I also compile a list of such inconsistencies and report them to software
development team.

In your example:

Prose portion (descriptive)

"....blah, blah, email address....blah, blah, email addresses...."

Actual step instructions:

"Enter the primary contact email address in the *Email Address* field."

Note that buttons can be references as you see above, where they're set in
boldface and surrounded by square brackets. UI items such as dialog box
titles and field names are set in boldface.

For more about such conventions, I suggest you refer to the 4th edition of
the *Microsoft Manual of Style*. (There are places on the 'Net from which
you can download a free PDF version.)

Chris Morton



â Substantive Editing â Technical Writing â Proofreading
          â Marketing Expertise â Mentoring
Click to
<http://t.sidekickopen68.com/e1t/c/5/f18dQhb0S7lC8dDMPbW2n0x6l2B9nMJN7t5XYgdnqQxW7fsH3H4XrddKW1pNgV-56dMhqf2Q-c6C02?t=https%3A%2F%2Fwww.linkedin.com%2Fpub%2Fchris-morton%2F2%2F166%2F6ba&si=6020636811198464Ï=6f115106-0a94-4f87-fec6-222709bc46f8>


On Tue, Nov 29, 2016 at 9:42 AM, Tony Chung <tonyc -at- tonychung -dot- ca> wrote:

> Yes. :-)
>
>
> Capitalize if referring to the specific feature or interface name.
>
> Don't capitalize if referring to the general purpose of the feature. As in
> your example.
>
> -Tony
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as salt -dot- morton -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> 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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as klhra -at- yahoo -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

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


References:
Capitalizing product names of product features: From: Karen Gwynn
Re: Capitalizing product names of product features: From: Tony Chung
Re: Capitalizing product names of product features: From: Chris Morton

Previous by Author: Capitalizing product names of product features
Next by Author: Has anyone combined their company's docs/downloads into a single page?
Previous by Thread: Re: Capitalizing product names of product features
Next by Thread: Re: Capitalizing product names of product features


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads