What are the best practices for how to name labels?

Frances Albrecht March 24, 2016

We're creating Information Architecture guidelines. Are there best practices for label names? I.e., should they be short, no more than two words in length joined by a hyphen, or does it matter? Pointers to any relevant IA guidance documentation (not already in the Atlassian help) would be much appreciated. 

2 answers

1 accepted

1 vote
Answer accepted
Milo Test
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
March 28, 2016

We use underscores to separate words as some actually contain hyphens, e.g. microsoft_hyper-v

1 vote
Alex Yasurek
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
March 24, 2016

All labels are lower case so if you have multiple word labels then you should use a hyphen to separate them since you can't use camel casing. For example: technical-documentation reads better than technicaldocumentation

The rest is really up to how you decide to create labels but I would suggest keeping them short. I would also create some standard certain type of pages, like pages that show help videos have a label "video" so you can then easily create a list of all pages that have help videos by just using the label "video".  Similar for other types of pages like release notes or FAQ pages.

Just remember that labels are useful for creating list of pages that appear in different sections of your space or in different spaces altogether.

 

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events