What are the best practices for how to name labels?

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

This widget could not be displayed.

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

This widget could not be displayed.

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
Community showcase
Posted Sep 17, 2018 in Confluence

Why start from scratch? Introducing four new templates for Confluence Cloud

Hi my Community friends!  For those who don't know me, I'm a product marketer on the Confluence Cloud team - nice to meet you! For those of you who do, you know that I've been all up in your Co...

603 views 8 6
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you