Jira & Confluence Label Standards
Labels observe the following conventions
- Case-sensitive: Labels are case-sensitive. Always use lower-case characters when adding labels to tickets. For example, Jira creates separate labels for the entries "Catalog" and "catalog".
- Spelling: Spelling differences in labels affect search results in Jira; for example, Jira distinguishes "pre-requisite" and "prerequisite" as unique terms. A search on "pre-requisite" may retrieve different tickets than a search on prerequisite.
- Jira labels are shared across Jira projects; Confluence labels are shared across all spaces
Suggested label conventions
- Re-use existing labels whenever possible. Having two labels that mean the same thing essentially renders the labeling system dysfunctional.
- The labels should be short and not too wordy. The labels should aid in filtering issues effectively and multiple labels are acceptable.
- Not preferred:
- performance-scalability-reliability-and-regulatory-report
- performance-and-scalability-report
- performance-scalability-reliability-and-not-regulatory-report
- Preferred:
- performance
- scalability
- reliability
- regulatory
- report
- Not preferred:
- Use abbreviations for lengthy labels. A label should be at least 3 characters in length.
- e.g., nfr (Non Functional Requirement)
- Use lower case with hyphens to separate words
- it-standard (hyphenated compounds)
Standard labels
Label | Represents | Description |
---|---|---|
meeting-index | Content Type | The first time a page is created using the Meeting Notes template, Confluence will create a page that lists all of the meeting pages in the space. This page is called the Meeting Index page and has the meeting-index label. |
decisions-index | Content Type | |
requirements-index | Content Type | |
retrospectives-index | Content Type | |
meeting-notes | Content Type | |
decisions | Content Type | |
requirements | Content Type | |
retrospectives | Content Type | |
it-ops | Team | Used in Confluence to indicate the content belongs to the IT Operations team. While all content in the IT Operations space belongs to the IT Operations team, the label is only required for aggregated content. Standards for all teams, for example, are aggregated to the IT space. This is used in the aggregation for team attribution. |
it-standards | Content Type | Used in Confluence to indicate the content type is an IT standard. This is required for all standards we write so that we can aggregate them from all sources. |
sql | Application/Service | |
iis | Application/Service | |
active-directory | Application/Service |