Creating a glossary and terms

Create a glossary to build consistent, common terminology for the project. You can create new terms that are stored in the repository and are included in the glossary. You can also add existing terms from the repository into the glossary. Adding terms from the repository enables you to use a term in more than one glossary.

About this task

Glossary terms can contain links to new and existing artifacts, related terms, and synonyms. They also can contain comments and acronyms. You can assign attributes to the glossary and view, filter, and sort links to other artifacts using the sidebar.

Procedure

  1. Click File > New > Glossary
  2. In the New Glossary window, type a name for the glossary. This name, which is displayed with the artifact in the project pages and the Project Explorer, can include uppercase and lowercase characters and spaces.
  3. Browse to a project and a folder for the glossary.
  4. (Optional) Add a tag to the new glossary.
  5. (Optional) Select a template for initial content for the new glossary.
  6. (Optional) Click Next and select the attribute groups that you want to apply to the glossary.
  7. Click Finish.
  8. Under the glossary name, click the <Enter Description> placeholder and type a description for the glossary.
  9. To create a new term and add it to the glossary:
    1. Click Add Term.
    2. At the <Enter Name> placeholder, type the glossary term.
    3. At the <Enter Definition> field, type the explanation for the glossary term.
    4. Add entries in the following fields: Related Terms, Synonyms, and Acronyms.
    5. Click OK.
  10. To add an existing term from the repository into the glossary:
    1. Click Add Existing Term.
    2. In the Add Existing Term window at the Term field, type an entry that provides a partial match for the term that is located in the repository.
    3. Select the term from the results list and click OK.
  11. For information about adding links and other details to the term, see Modifying a glossary and terms.

What to do next

The term defaults to a draft state. After an approval of the term and its definition by the project stakeholders, change the status from Draft to Published. Obsolete terms can be a Deprecated status.

Feedback