RE: Convention for navigation labels in documentation

Subject: RE: Convention for navigation labels in documentation
From: "Courtney, Robert" <Robert -dot- Courtney -at- sorin -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 22 Oct 2013 20:18:54 +0000

Yeah, there are no real standards. It is up to you and the organization to create your style. I know I have used the MS Manual of Style for some ideas. At least it helped me to get some.

Bob



----------------------------------------------------------------------
This email contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing or copying this message or otherwise making use of the information contained herein is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter.

Thank you.
----------------------------------------------------------------------

-----Original Message-----
From: techwr-l-bounces+robert -dot- courtney=sorin -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+robert -dot- courtney=sorin -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Robert Lauriston
Sent: Tuesday, October 22, 2013 1:14 PM
To: Ron Hearn
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Convention for navigation labels in documentation

Definitely no standard, different places I've worked have had different conventions. I think the most common is bold.

Italic is commonly used for placeholders for strings that will vary from one user to another.

On Tue, Oct 22, 2013 at 1:04 PM, Ron Hearn <rhearn -at- central1 -dot- com> wrote:
> Hi all,
>
> Our Product Marketing Manager asked me if there is an industry standard for the font treatment used when describing the names of labels for navigation that exists within a program. For instance, if we were to describe the following:
>
> You'll find this report in Adobe Analytics under Site Metrics > Anomaly Detection.
>
> Should bold, italics or " " marks for Site Metrics > Anomaly Detection?
>
> I generally use bold for the labels, but it would be nice to know if there is a general standard.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

You are currently subscribed to TECHWR-L as Robert -dot- Courtney -at- sorin -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


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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


Follow-Ups:

References:
Convention for navigation labels in documentation: From: Ron Hearn
Re: Convention for navigation labels in documentation: From: Robert Lauriston

Previous by Author: OT: The state of journalism
Next by Author: Need alternative to Mozilla Thunderbird
Previous by Thread: Re: Convention for navigation labels in documentation
Next by Thread: RE: Convention for navigation labels in documentation


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

Sponsored Ads


Sponsored Ads