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: 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.
-----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.
