/
Glossary: Managing Project Glossaries

Glossary: Managing Project Glossaries

Overview

data center only

A well-defined glossary of terms is crucial for requirements management, establishing a shared understanding of terminology specific to your organization, industry regulations, and your project's unique context. This controlled vocabulary promotes clarity and consistency in requirements definition, reducing ambiguity and improving interpretation.

In projects associated with a given glossary, terms occurring in requirements that are defined in the glossary are displayed in a distinctive manner with the definition directly available – see Glossary Terms in Detail View.

To configure glossaries and associate them with projects or project categories, you need the "Glossary Configuration" user permission - see Managing User Permissions.

Glossary concepts

A Glossary is a collection Glossary Terms, which are Jira issues in which the Summary serves as the term itself, and the Description provides the definition of that term. A Glossary Term can consist of multiple words.

The Jira issues defining the Glossary Terms are located in a project tree folder designated as the Glossary Folder.

Since each glossary term's definition is stored as a Jira issue, ensure that users have the necessary project permissions for projects containing glossaries.

Operations

To manage glossaries, select Requirements > Glossary Configuration in the Jira main navigation bar.

Purpose

Action

Comment

Purpose

Action

Comment

Add Glossary Configuration

  • Select Add Glossary.

  • In the dialog, select the Project containing the desired glossary folder.

  • Select the glossary folder.

  • Select Add.

Any project, and any folder in the project, can be used to host a glossary. Every issue in the designated folder is treated as defining a glossary term.

If the glossary is associated with more than one project, it is highly recommended to locate it in a separate, dedicated project.

A dedicated issue type for glossary terms is not required, but a type such as “Glossary Term” is recommended.

Edit Glossary Configuration

  • Select Edit in the Actions column of the desired glossary.

  • In the dialog, change the Project or Glossary Folder as desired.

  • Select Update.

 

Associate Projects or Project Categories with Glossary Configuration

  • Select Associate in the Actions column of the desired glossary.

  • Enable or disable Associate Glossary to All Projects.

  • If you decide to disable the option, you need to manually add or remove projects and project categories as desired.

  • Select Associate.

 

Delete Glossary Configuration

  • Select Delete in the Actions column of the desired glossary.

  • In the confirmation dialog, select Delete.

You can only delete a Glossary Configuration if it is not associated with any project or project category.

Enable or Disable Case-sensitive evaluation for Glossary Configuration

  • Enable or disable the toggle button in the Case-sensitive column.